GetDeployment - AWS IoT Greengrass

GetDeployment

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

Request Syntax

GET /greengrass/v2/deployments/deploymentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

deploymentId

The ID of the deployment.

Length Constraints: Minimum length of 1.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "components": { "string" : { "componentVersion": "string", "configurationUpdate": { "merge": "string", "reset": [ "string" ] }, "runWith": { "posixUser": "string" } } }, "creationTimestamp": number, "deploymentId": "string", "deploymentName": "string", "deploymentPolicies": { "componentUpdatePolicy": { "action": "string", "timeoutInSeconds": number }, "configurationValidationPolicy": { "timeoutInSeconds": number }, "failureHandlingPolicy": "string" }, "deploymentStatus": "string", "iotJobArn": "string", "iotJobConfiguration": { "abortConfig": { "criteriaList": [ { "action": "string", "failureType": "string", "minNumberOfExecutedThings": number, "thresholdPercentage": number } ] }, "jobExecutionsRolloutConfig": { "exponentialRate": { "baseRatePerMinute": number, "incrementFactor": number, "rateIncreaseCriteria": { "numberOfNotifiedThings": number, "numberOfSucceededThings": number } }, "maximumPerMinute": number }, "timeoutConfig": { "inProgressTimeoutInMinutes": number } }, "iotJobId": "string", "isLatestForTarget": boolean, "revisionId": "string", "tags": { "string" : "string" }, "targetArn": "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.

components

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.

Type: String to ComponentDeploymentSpecification object map

Key Length Constraints: Minimum length of 1.

creationTimestamp

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

Type: Timestamp

deploymentId

The ID of the deployment.

Type: String

Length Constraints: Minimum length of 1.

deploymentName

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Type: String

deploymentPolicies

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Type: DeploymentPolicies object

deploymentStatus

The status of the deployment.

Type: String

Valid Values: ACTIVE | COMPLETED | CANCELED | FAILED | INACTIVE

iotJobArn

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

Type: String

Pattern: arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:job/.+

iotJobConfiguration

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Type: DeploymentIoTJobConfiguration object

iotJobId

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

Type: String

isLatestForTarget

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

Type: Boolean

revisionId

The revision number of the deployment.

Type: String

Length Constraints: Minimum length of 1.

tags

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

targetArn

The ARN of the target AWS IoT thing or thing group.

Type: String

Pattern: arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:(thing|thinggroup)/.+

Errors

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

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

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