Skip to content

list_custom_model_deployments

Operation

list_custom_model_deployments

list_custom_model_deployments(request: ListCustomModelDeploymentsInput | ListCustomModelDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCustomModelDeploymentsInputDict]) -> ListCustomModelDeploymentsOutput

Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.

We recommend using pagination to ensure that the operation returns quickly and successfully.

The following actions are related to the ListCustomModelDeployments operation:

Parameters:

Name Type Description Default
request ListCustomModelDeploymentsInput | ListCustomModelDeploymentsInputDict | 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[ListCustomModelDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomModelDeploymentsOutput

An instance of ListCustomModelDeploymentsOutput.

list_custom_model_deployments async

list_custom_model_deployments(request: ListCustomModelDeploymentsInput | ListCustomModelDeploymentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCustomModelDeploymentsInputDict]) -> ListCustomModelDeploymentsOutput

Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.

We recommend using pagination to ensure that the operation returns quickly and successfully.

The following actions are related to the ListCustomModelDeployments operation:

Parameters:

Name Type Description Default
request ListCustomModelDeploymentsInput | ListCustomModelDeploymentsInputDict | 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[ListCustomModelDeploymentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomModelDeploymentsOutput

An instance of ListCustomModelDeploymentsOutput.

Input

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

ListCustomModelDeploymentsInputDict

Bases: TypedDict

Dictionary form of ListCustomModelDeploymentsInput.

Attributes

created_after instance-attribute
created_after: datetime | None

Filters deployments created after the specified date and time.

created_before instance-attribute
created_before: datetime | None

Filters deployments created before the specified date and time.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call.

model_arn_equals instance-attribute
model_arn_equals: str | None

Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

name_contains instance-attribute
name_contains: str | None

Filters deployments whose names contain the specified string.

next_token instance-attribute
next_token: str | None

The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

sort_by instance-attribute
sort_by: str | None

The field to sort the results by. The only supported value is CreationTime.

sort_order instance-attribute
sort_order: str | None

The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

status_equals instance-attribute
status_equals: str | None

Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

ListCustomModelDeploymentsInput dataclass

Bases: _SerdeShape

Dataclass for ListCustomModelDeploymentsInput structure.

Attributes

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

Filters deployments created after the specified date and time.

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

Filters deployments created before the specified date and time.

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

The maximum number of results to return in a single call.

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

Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

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

Filters deployments whose names contain the specified string.

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

The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

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

The field to sort the results by. The only supported value is CreationTime.

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

The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

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

Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

Output

ListCustomModelDeploymentsOutput dataclass

Bases: _SerdeShape

Dataclass for ListCustomModelDeploymentsOutput structure.

Attributes

model_deployment_summaries class-attribute instance-attribute
model_deployment_summaries: list[CustomModelDeploymentSummary] | None = ...

A list of custom model deployment summaries.

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

The token for the next set of results. This value is null when there are no more results to return.

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.