DescribeEdgeDeploymentPlan - 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.

DescribeEdgeDeploymentPlan

Describes an edge deployment plan with deployment status per stage.

Request Syntax

{ "EdgeDeploymentPlanName": "string", "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EdgeDeploymentPlanName

The name of the deployment plan to describe.

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

MaxResults

The maximum number of results to select (50 by default).

Type: Integer

Valid Range: Maximum value of 10.

Required: No

NextToken

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

Response Syntax

{ "CreationTime": number, "DeviceFleetName": "string", "EdgeDeploymentFailed": number, "EdgeDeploymentPending": number, "EdgeDeploymentPlanArn": "string", "EdgeDeploymentPlanName": "string", "EdgeDeploymentSuccess": number, "LastModifiedTime": number, "ModelConfigs": [ { "EdgePackagingJobName": "string", "ModelHandle": "string" } ], "NextToken": "string", "Stages": [ { "DeploymentConfig": { "FailureHandlingPolicy": "string" }, "DeploymentStatus": { "EdgeDeploymentFailedInStage": number, "EdgeDeploymentPendingInStage": number, "EdgeDeploymentStageStartTime": number, "EdgeDeploymentStatusMessage": "string", "EdgeDeploymentSuccessInStage": number, "StageStatus": "string" }, "DeviceSelectionConfig": { "DeviceNameContains": "string", "DeviceNames": [ "string" ], "DeviceSubsetType": "string", "Percentage": number }, "StageName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreationTime

The time when the edge deployment plan was created.

Type: Timestamp

DeviceFleetName

The device fleet used for this 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}$

EdgeDeploymentFailed

The number of edge devices that failed the deployment.

Type: Integer

EdgeDeploymentPending

The number of edge devices yet to pick up deployment, or in progress.

Type: Integer

EdgeDeploymentPlanArn

The ARN of 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+=,.@\-_/]+$

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}$

EdgeDeploymentSuccess

The number of edge devices with the successful deployment.

Type: Integer

LastModifiedTime

The time when the edge deployment plan was last updated.

Type: Timestamp

ModelConfigs

List of models associated with the edge deployment plan.

Type: Array of EdgeDeploymentModelConfig objects

NextToken

Token to use when calling the next set of stages in the edge deployment plan.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Stages

List of stages in the edge deployment plan.

Type: Array of DeploymentStageStatusSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

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