v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Describes an edge deployment plan with deployment status per stage.

post/#X-Amz-Target=SageMaker.DescribeEdgeDeploymentPlan

Headers

X-Amz-Target'SageMaker.DescribeEdgeDeploymentPlan' required

Request body

EdgeDeploymentPlanNamestring required

The name of the deployment plan to describe.

NextTokenstring

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

MaxResultsinteger

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

Response

Success

EdgeDeploymentPlanArnstring required

The ARN of edge deployment plan.

EdgeDeploymentPlanNamestring required

The name of the edge deployment plan.

DeviceFleetNamestring required

The device fleet used for this edge deployment plan.

EdgeDeploymentSuccessinteger

The number of edge devices with the successful deployment.

EdgeDeploymentPendinginteger

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

EdgeDeploymentFailedinteger

The number of edge devices that failed the deployment.

NextTokenstring

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

CreationTimestring date-time

The time when the edge deployment plan was created.

LastModifiedTimestring date-time

The time when the edge deployment plan was last updated.