EffectiveDeployment - Amazon IoT Greengrass
ContentsSee Also
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).

EffectiveDeployment

Contains information about a deployment job that Amazon IoT Greengrass sends to a Greengrass core device.

Contents

coreDeviceExecutionStatus

The status of the deployment job on the Greengrass core device.

  • IN_PROGRESS – The deployment job is running.

  • QUEUED – The deployment job is in the job queue and waiting to run.

  • FAILED – The deployment failed. For more information, see the statusDetails field.

  • COMPLETED – The deployment to an Amazon IoT thing was completed successfully.

  • TIMED_OUT – The deployment didn't complete in the allotted time.

  • CANCELED – The deployment was canceled by the user.

  • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

  • SUCCEEDED – The deployment to an Amazon IoT thing group was completed successfully.

Type: String

Valid Values: IN_PROGRESS | QUEUED | FAILED | COMPLETED | TIMED_OUT | CANCELED | REJECTED | SUCCEEDED

Required: Yes

creationTimestamp

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

Type: Timestamp

Required: Yes

deploymentId

The ID of the deployment.

Type: String

Required: Yes

deploymentName

The name of the deployment.

Type: String

Required: Yes

modifiedTimestamp

The time at which the deployment job was last modified, expressed in ISO 8601 format.

Type: Timestamp

Required: Yes

targetArn

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

Type: String

Pattern: arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+

Required: Yes

description

The description of the deployment job.

Type: String

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

Required: No

iotJobArn

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

Type: String

Pattern: arn:[^:]*:iot:[^:]+:[0-9]+:job/.+

Required: No

iotJobId

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

Type: String

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

Required: No

reason

The reason code for the update, if the job was updated.

Type: String

Required: No

statusDetails

The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.

Type: EffectiveDeploymentStatusDetails object

Required: No

See Also

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