DeviceDeploymentSummary - 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).

DeviceDeploymentSummary

Contains information summarizing device details and deployment status.

Contents

DeviceArn

The ARN of the device.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:[a-z\-]*:[a-z\-]*:\d{12}:[a-z\-]*/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes

DeviceName

The name of the device.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

EdgeDeploymentPlanArn

The ARN of the edge deployment plan.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z\-]*:\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes

EdgeDeploymentPlanName

The name of the edge deployment plan.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

StageName

The name of the stage in the edge deployment plan.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

DeployedStageName

The name of the deployed stage.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

DeploymentStartTime

The time when the deployment on the device started.

Type: Timestamp

Required: No

Description

The description of the device.

Type: String

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

Pattern: ^[-a-zA-Z0-9_.,;:! ]*$

Required: No

DeviceDeploymentStatus

The deployment status of the device.

Type: String

Valid Values: READYTODEPLOY | INPROGRESS | DEPLOYED | FAILED | STOPPING | STOPPED

Required: No

DeviceDeploymentStatusMessage

The detailed error message for the deployoment status result.

Type: String

Required: No

DeviceFleetName

The name of the fleet to which the device belongs to.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

See Also

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