EffectiveDeployment - AWS IoT Greengrass

EffectiveDeployment

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

Contents

coreDeviceExecutionStatus

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

Type: String

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

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.

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

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 AWS IoT job that applies the deployment to target devices.

Type: String

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

Required: No

iotJobId

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

Type: String

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

Required: No

modifiedTimestamp

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

Type: Timestamp

Required: Yes

reason

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

Type: String

Required: No

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)/.+

Required: Yes

See Also

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