Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1429208152.7 KB

Gets a deployment. Deployments define the components that run on Greengrass core devices.

get/greengrass/v2/deployments/{deploymentId}

Path parameters

deploymentIdstring required

The ID of the deployment.

Response

Success

targetArnstring

The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.

revisionIdstring

The revision number of the deployment.

deploymentIdstring

The ID of the deployment.

deploymentNamestring

The name of the deployment.

deploymentStatus'ACTIVE' | 'COMPLETED' | 'CANCELED' | 'FAILED' | 'INACTIVE'

The status of the deployment.

iotJobIdstring

The ID of the IoT job that applies the deployment to target devices.

iotJobArnstring

The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.

componentsobject

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

creationTimestampstring date-time

The time at which the deployment was created, expressed in ISO 8601 format.

isLatestForTargetboolean

Whether or not the deployment is the latest revision for its target.

parentTargetArnstring

The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.

tagsobject

A list of key-value pairs that contain metadata for the resource. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.