/AWS1/CL_GG2GETDEPLOYMENTRSP¶
GetDeploymentResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_targetarn TYPE /AWS1/GG2TARGETARN /AWS1/GG2TARGETARN¶
The ARN of the target IoT thing or thing group.
iv_revisionid TYPE /AWS1/GG2NONEMPTYSTRING /AWS1/GG2NONEMPTYSTRING¶
The revision number of the deployment.
iv_deploymentid TYPE /AWS1/GG2NONEMPTYSTRING /AWS1/GG2NONEMPTYSTRING¶
The ID of the deployment.
iv_deploymentname TYPE /AWS1/GG2NULLABLESTRING /AWS1/GG2NULLABLESTRING¶
The name of the deployment.
iv_deploymentstatus TYPE /AWS1/GG2DEPLOYMENTSTATUS /AWS1/GG2DEPLOYMENTSTATUS¶
The status of the deployment.
iv_iotjobid TYPE /AWS1/GG2NULLABLESTRING /AWS1/GG2NULLABLESTRING¶
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.
it_components TYPE /AWS1/CL_GG2COMPONENTDEPLOYM00=>TT_COMPONENTDEPLOYMENTSPECS TT_COMPONENTDEPLOYMENTSPECS¶
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.
io_deploymentpolicies TYPE REF TO /AWS1/CL_GG2DEPLOYMENTPOLICIES /AWS1/CL_GG2DEPLOYMENTPOLICIES¶
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
io_iotjobconfiguration TYPE REF TO /AWS1/CL_GG2DEPLOYMENTIOTJOB00 /AWS1/CL_GG2DEPLOYMENTIOTJOB00¶
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
iv_creationtimestamp TYPE /AWS1/GG2TIMESTAMP /AWS1/GG2TIMESTAMP¶
The time at which the deployment was created, expressed in ISO 8601 format.
iv_islatestfortarget TYPE /AWS1/GG2ISLATESTFORTARGET /AWS1/GG2ISLATESTFORTARGET¶
Whether or not the deployment is the latest revision for its target.
iv_parenttargetarn TYPE /AWS1/GG2THINGGROUPARN /AWS1/GG2THINGGROUPARN¶
The parent deployment's target ARN within a subdeployment.
it_tags TYPE /AWS1/CL_GG2TAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
Queryable Attributes¶
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 |
revisionId¶
The revision number of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REVISIONID() |
Getter for REVISIONID, with configurable default |
ASK_REVISIONID() |
Getter for REVISIONID w/ exceptions if field has no value |
HAS_REVISIONID() |
Determine if REVISIONID has a value |
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 |
deploymentStatus¶
The status of the deployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTSTATUS() |
Getter for DEPLOYMENTSTATUS, with configurable default |
ASK_DEPLOYMENTSTATUS() |
Getter for DEPLOYMENTSTATUS w/ exceptions if field has no va |
HAS_DEPLOYMENTSTATUS() |
Determine if DEPLOYMENTSTATUS 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 |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPONENTS() |
Getter for COMPONENTS, with configurable default |
ASK_COMPONENTS() |
Getter for COMPONENTS w/ exceptions if field has no value |
HAS_COMPONENTS() |
Determine if COMPONENTS has a value |
deploymentPolicies¶
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTPOLICIES() |
Getter for DEPLOYMENTPOLICIES |
iotJobConfiguration¶
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IOTJOBCONFIGURATION() |
Getter for IOTJOBCONFIGURATION |
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 |
isLatestForTarget¶
Whether or not the deployment is the latest revision for its target.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISLATESTFORTARGET() |
Getter for ISLATESTFORTARGET |
parentTargetArn¶
The parent deployment's target ARN within a subdeployment.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARENTTARGETARN() |
Getter for PARENTTARGETARN, with configurable default |
ASK_PARENTTARGETARN() |
Getter for PARENTTARGETARN w/ exceptions if field has no val |
HAS_PARENTTARGETARN() |
Determine if PARENTTARGETARN has a value |
tags¶
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |