Skip to content

get_custom_model_deployment

Operation

get_custom_model_deployment

get_custom_model_deployment(request: GetCustomModelDeploymentInput | GetCustomModelDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomModelDeploymentInputDict]) -> GetCustomModelDeploymentOutput

Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.

The following actions are related to the GetCustomModelDeployment operation:

Parameters:

Name Type Description Default
request GetCustomModelDeploymentInput | GetCustomModelDeploymentInputDict | 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[GetCustomModelDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomModelDeploymentOutput

An instance of GetCustomModelDeploymentOutput.

get_custom_model_deployment async

get_custom_model_deployment(request: GetCustomModelDeploymentInput | GetCustomModelDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomModelDeploymentInputDict]) -> GetCustomModelDeploymentOutput

Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.

The following actions are related to the GetCustomModelDeployment operation:

Parameters:

Name Type Description Default
request GetCustomModelDeploymentInput | GetCustomModelDeploymentInputDict | 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[GetCustomModelDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomModelDeploymentOutput

An instance of GetCustomModelDeploymentOutput.

Input

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

GetCustomModelDeploymentInputDict

Bases: TypedDict

Dictionary form of GetCustomModelDeploymentInput.

Attributes

custom_model_deployment_identifier instance-attribute
custom_model_deployment_identifier: Required[str]

The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.

GetCustomModelDeploymentInput dataclass

Bases: _SerdeShape

Dataclass for GetCustomModelDeploymentInput structure.

Attributes

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

The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.

Output

GetCustomModelDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for GetCustomModelDeploymentOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The date and time when the custom model deployment was created.

custom_model_deployment_arn instance-attribute
custom_model_deployment_arn: str

The Amazon Resource Name (ARN) of the custom model deployment.

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

The description of the custom model deployment.

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

If the deployment status is FAILED, this field contains a message describing the failure reason.

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

The date and time when the custom model deployment was last updated.

model_arn instance-attribute
model_arn: str

The Amazon Resource Name (ARN) of the custom model associated with this deployment.

model_deployment_name instance-attribute
model_deployment_name: str

The name of the custom model deployment.

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.

status instance-attribute
status: str

The status of the custom model deployment. Possible values are:

  • CREATING - The deployment is being set up and prepared for inference.

  • ACTIVE - The deployment is ready and available for inference requests.

  • FAILED - The deployment failed to be created or became unavailable.

update_details class-attribute instance-attribute
update_details: CustomModelDeploymentUpdateDetails | None = ...

Details about any pending or completed updates to the custom model deployment, including the new model ARN and update status.