list_custom_model_deployments¶
Operation¶
async
¶
list_custom_model_deployments(input: ListCustomModelDeploymentsInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
ListCustomModelDeploymentsInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ListCustomModelDeploymentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListCustomModelDeploymentsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
created_after: datetime | None = None
Filters deployments created after the specified date and time.
class-attribute
instance-attribute
¶
created_before: datetime | None = None
Filters deployments created before the specified date and time.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in a single call.
class-attribute
instance-attribute
¶
model_arn_equals: str | None = None
Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.
class-attribute
instance-attribute
¶
name_contains: str | None = None
Filters deployments whose names contain the specified string.
class-attribute
instance-attribute
¶
next_token: str | None = None
The token for the next set of results. Use this token to retrieve additional results when the response is truncated.
class-attribute
instance-attribute
¶
sort_by: SortModelsBy | None = None
The field to sort the results by. The only supported value is
CreationTime.
class-attribute
instance-attribute
¶
sort_order: SortOrder | None = None
The sort order for the results. Valid values are Ascending and
Descending. Default is Descending.
class-attribute
instance-attribute
¶
status_equals: CustomModelDeploymentStatus | None = None
Filters deployments by status. Valid values are CREATING, ACTIVE,
and FAILED.
Output¶
dataclass
¶
Dataclass for ListCustomModelDeploymentsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
model_deployment_summaries: list[CustomModelDeploymentSummary] | None = None
A list of custom model deployment summaries.
class-attribute
instance-attribute
¶
next_token: str | None = None
The token for the next set of results. This value is null when there are no more results to return.