DeploymentModel - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 Amazon SDKs, see the following: