Skip to content

list_model_customization_jobs

Operation

list_model_customization_jobs

list_model_customization_jobs(request: ListModelCustomizationJobsInput | ListModelCustomizationJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListModelCustomizationJobsInputDict]) -> ListModelCustomizationJobsOutput

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

For more information, see Custom models in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request ListModelCustomizationJobsInput | ListModelCustomizationJobsInputDict | 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[ListModelCustomizationJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListModelCustomizationJobsOutput

An instance of ListModelCustomizationJobsOutput.

list_model_customization_jobs async

list_model_customization_jobs(request: ListModelCustomizationJobsInput | ListModelCustomizationJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListModelCustomizationJobsInputDict]) -> ListModelCustomizationJobsOutput

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

For more information, see Custom models in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request ListModelCustomizationJobsInput | ListModelCustomizationJobsInputDict | 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[ListModelCustomizationJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListModelCustomizationJobsOutput

An instance of ListModelCustomizationJobsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListModelCustomizationJobsInputDict

Bases: TypedDict

Dictionary form of ListModelCustomizationJobsInput.

Attributes

creation_time_after instance-attribute
creation_time_after: datetime | None

Return customization jobs created after the specified time.

creation_time_before instance-attribute
creation_time_before: datetime | None

Return customization jobs created before the specified time.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

name_contains instance-attribute
name_contains: str | None

Return customization jobs only if the job name contains these characters.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

sort_by instance-attribute
sort_by: str | None

The field to sort by in the returned list of jobs.

sort_order instance-attribute
sort_order: str | None

The sort order of the results.

status_equals instance-attribute
status_equals: str | None

Return customization jobs with the specified status.

ListModelCustomizationJobsInput dataclass

Bases: _SerdeShape

Dataclass for ListModelCustomizationJobsInput structure.

Attributes

creation_time_after class-attribute instance-attribute
creation_time_after: datetime | None = ...

Return customization jobs created after the specified time.

creation_time_before class-attribute instance-attribute
creation_time_before: datetime | None = ...

Return customization jobs created before the specified time.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

name_contains class-attribute instance-attribute
name_contains: str | None = ...

Return customization jobs only if the job name contains these characters.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

sort_by class-attribute instance-attribute
sort_by: str | None = ...

The field to sort by in the returned list of jobs.

sort_order class-attribute instance-attribute
sort_order: str | None = ...

The sort order of the results.

status_equals class-attribute instance-attribute
status_equals: str | None = ...

Return customization jobs with the specified status.

Output

ListModelCustomizationJobsOutput dataclass

Bases: _SerdeShape

Dataclass for ListModelCustomizationJobsOutput structure.

Attributes

model_customization_job_summaries class-attribute instance-attribute
model_customization_job_summaries: list[ModelCustomizationJobSummary] | None = ...

Job summaries.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.