list_evaluation_jobs¶
Operation¶
list_evaluation_jobs
¶
list_evaluation_jobs(request: ListEvaluationJobsInput | ListEvaluationJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEvaluationJobsInputDict]) -> ListEvaluationJobsOutput
Lists all existing evaluation jobs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEvaluationJobsInput | ListEvaluationJobsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListEvaluationJobsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEvaluationJobsOutput
|
An instance of |
list_evaluation_jobs
async
¶
list_evaluation_jobs(request: ListEvaluationJobsInput | ListEvaluationJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEvaluationJobsInputDict]) -> ListEvaluationJobsOutput
Lists all existing evaluation jobs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEvaluationJobsInput | ListEvaluationJobsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListEvaluationJobsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEvaluationJobsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListEvaluationJobsInputDict
¶
Bases: TypedDict
Dictionary form of ListEvaluationJobsInput.
Attributes¶
application_type_equals
instance-attribute
¶
application_type_equals: str | None
A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.
creation_time_after
instance-attribute
¶
creation_time_after: datetime | None
A filter to only list evaluation jobs created after a specified time.
creation_time_before
instance-attribute
¶
creation_time_before: datetime | None
A filter to only list evaluation jobs created before a specified time.
name_contains
instance-attribute
¶
name_contains: str | None
A filter to only list evaluation jobs that contain a specified string in the job name.
next_token
instance-attribute
¶
next_token: str | None
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
sort_by
instance-attribute
¶
sort_by: str | None
Specifies a creation time to sort the list of evaluation jobs by when they were created.
ListEvaluationJobsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListEvaluationJobsInput structure.
Attributes¶
application_type_equals
class-attribute
instance-attribute
¶
application_type_equals: str | None = ...
A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.
creation_time_after
class-attribute
instance-attribute
¶
creation_time_after: datetime | None = ...
A filter to only list evaluation jobs created after a specified time.
creation_time_before
class-attribute
instance-attribute
¶
creation_time_before: datetime | None = ...
A filter to only list evaluation jobs created before a specified time.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return.
name_contains
class-attribute
instance-attribute
¶
name_contains: str | None = ...
A filter to only list evaluation jobs that contain a specified string in the job name.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
sort_by
class-attribute
instance-attribute
¶
sort_by: str | None = ...
Specifies a creation time to sort the list of evaluation jobs by when they were created.
Output¶
ListEvaluationJobsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListEvaluationJobsOutput structure.
Attributes¶
job_summaries
class-attribute
instance-attribute
¶
job_summaries: list[EvaluationSummary] | None = ...
A list of summaries of the evaluation jobs.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.