Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

DeploymentModel - Amazon SageMaker

DeploymentModel

Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.

Contents

DesiredState

The desired state of the model.

Type: String

Valid Values: DEPLOY | UNDEPLOY

Required: No

ModelHandle

The name by which the device refers to the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: No

ModelName

The name of the model.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 255.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: No

ModelVersion

The version of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9\ \_\.]+

Required: No

RollbackFailureReason

Returns the error message if there is a rollback.

Type: String

Required: No

State

Returns the current state of the model.

Type: String

Valid Values: DEPLOY | UNDEPLOY

Required: No

Status

Returns the deployment status of the model.

Type: String

Valid Values: SUCCESS | FAIL

Required: No

StatusReason

Returns the error message for the deployment status result.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.