/AWS1/CL_GG2EFFECTIVEDEPLOYM00¶
Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_deploymentid TYPE /AWS1/GG2DEPLOYMENTID /AWS1/GG2DEPLOYMENTID¶
The ID of the deployment.
iv_deploymentname TYPE /AWS1/GG2DEPLOYMENTNAME /AWS1/GG2DEPLOYMENTNAME¶
The name of the deployment.
iv_targetarn TYPE /AWS1/GG2TARGETARN /AWS1/GG2TARGETARN¶
The ARN of the target IoT thing or thing group.
iv_coredeviceexecutionstatus TYPE /AWS1/GG2EFFECTIVEDEPLOYMENT00 /AWS1/GG2EFFECTIVEDEPLOYMENT00¶
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 thestatusDetailsfield.
COMPLETED– The deployment to an 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 thestatusDetailsfield.
SUCCEEDED– The deployment to an IoT thing group was completed successfully.
iv_creationtimestamp TYPE /AWS1/GG2TIMESTAMP /AWS1/GG2TIMESTAMP¶
The time at which the deployment was created, expressed in ISO 8601 format.
iv_modifiedtimestamp TYPE /AWS1/GG2TIMESTAMP /AWS1/GG2TIMESTAMP¶
The time at which the deployment job was last modified, expressed in ISO 8601 format.
Optional arguments:¶
iv_iotjobid TYPE /AWS1/GG2IOTJOBID /AWS1/GG2IOTJOBID¶
The ID of the IoT job that applies the deployment to target devices.
iv_iotjobarn TYPE /AWS1/GG2IOTJOBARN /AWS1/GG2IOTJOBARN¶
The ARN of the IoT job that applies the deployment to target devices.
iv_description TYPE /AWS1/GG2DESCRIPTION /AWS1/GG2DESCRIPTION¶
The description of the deployment job.
iv_reason TYPE /AWS1/GG2REASON /AWS1/GG2REASON¶
The reason code for the update, if the job was updated.
io_statusdetails TYPE REF TO /AWS1/CL_GG2EFFECTIVEDEPLOYM01 /AWS1/CL_GG2EFFECTIVEDEPLOYM01¶
The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
Queryable Attributes¶
deploymentId¶
The ID of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTID() |
Getter for DEPLOYMENTID, with configurable default |
ASK_DEPLOYMENTID() |
Getter for DEPLOYMENTID w/ exceptions if field has no value |
HAS_DEPLOYMENTID() |
Determine if DEPLOYMENTID has a value |
deploymentName¶
The name of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTNAME() |
Getter for DEPLOYMENTNAME, with configurable default |
ASK_DEPLOYMENTNAME() |
Getter for DEPLOYMENTNAME w/ exceptions if field has no valu |
HAS_DEPLOYMENTNAME() |
Determine if DEPLOYMENTNAME has a value |
iotJobId¶
The ID of the IoT job that applies the deployment to target devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IOTJOBID() |
Getter for IOTJOBID, with configurable default |
ASK_IOTJOBID() |
Getter for IOTJOBID w/ exceptions if field has no value |
HAS_IOTJOBID() |
Determine if IOTJOBID has a value |
iotJobArn¶
The ARN of the IoT job that applies the deployment to target devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IOTJOBARN() |
Getter for IOTJOBARN, with configurable default |
ASK_IOTJOBARN() |
Getter for IOTJOBARN w/ exceptions if field has no value |
HAS_IOTJOBARN() |
Determine if IOTJOBARN has a value |
description¶
The description of the deployment job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
targetArn¶
The ARN of the target IoT thing or thing group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETARN() |
Getter for TARGETARN, with configurable default |
ASK_TARGETARN() |
Getter for TARGETARN w/ exceptions if field has no value |
HAS_TARGETARN() |
Determine if TARGETARN has a value |
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 thestatusDetailsfield.
COMPLETED– The deployment to an 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 thestatusDetailsfield.
SUCCEEDED– The deployment to an IoT thing group was completed successfully.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COREDEVICEEXECSTATUS() |
Getter for COREDEVICEEXECUTIONSTATUS, with configurable defa |
ASK_COREDEVICEEXECSTATUS() |
Getter for COREDEVICEEXECUTIONSTATUS w/ exceptions if field |
HAS_COREDEVICEEXECSTATUS() |
Determine if COREDEVICEEXECUTIONSTATUS has a value |
reason¶
The reason code for the update, if the job was updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REASON() |
Getter for REASON, with configurable default |
ASK_REASON() |
Getter for REASON w/ exceptions if field has no value |
HAS_REASON() |
Determine if REASON has a value |
creationTimestamp¶
The time at which the deployment was created, expressed in ISO 8601 format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIMESTAMP() |
Getter for CREATIONTIMESTAMP, with configurable default |
ASK_CREATIONTIMESTAMP() |
Getter for CREATIONTIMESTAMP w/ exceptions if field has no v |
HAS_CREATIONTIMESTAMP() |
Determine if CREATIONTIMESTAMP has a value |
modifiedTimestamp¶
The time at which the deployment job was last modified, expressed in ISO 8601 format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODIFIEDTIMESTAMP() |
Getter for MODIFIEDTIMESTAMP, with configurable default |
ASK_MODIFIEDTIMESTAMP() |
Getter for MODIFIEDTIMESTAMP w/ exceptions if field has no v |
HAS_MODIFIEDTIMESTAMP() |
Determine if MODIFIEDTIMESTAMP has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSDETAILS() |
Getter for STATUSDETAILS |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_EFFECTIVEDEPLOYMENTSLIST¶
TYPES TT_EFFECTIVEDEPLOYMENTSLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GG2EFFECTIVEDEPLOYM00 WITH DEFAULT KEY
.