/AWS1/CL_IOTOTAUPDATEINFO¶
Information about an OTA update.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_OTAUPDATEID TYPE /AWS1/IOTOTAUPDATEID /AWS1/IOTOTAUPDATEID¶
The OTA update ID.
IV_OTAUPDATEARN TYPE /AWS1/IOTOTAUPDATEARN /AWS1/IOTOTAUPDATEARN¶
The OTA update ARN.
IV_CREATIONDATE TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The date when the OTA update was created.
IV_LASTMODIFIEDDATE TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The date when the OTA update was last updated.
IV_DESCRIPTION TYPE /AWS1/IOTOTAUPDATEDESCRIPTION /AWS1/IOTOTAUPDATEDESCRIPTION¶
A description of the OTA update.
IT_TARGETS TYPE /AWS1/CL_IOTTARGETS_W=>TT_TARGETS TT_TARGETS¶
The targets of the OTA update.
IT_PROTOCOLS TYPE /AWS1/CL_IOTPROTOCOLS_W=>TT_PROTOCOLS TT_PROTOCOLS¶
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
IO_AWSJOBEXECSROLLOUTCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBEXESRLTCFG /AWS1/CL_IOTAWSJOBEXESRLTCFG¶
Configuration for the rollout of OTA updates.
IO_AWSJOBPRESIGNEDURLCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBPRESIGURLCFG /AWS1/CL_IOTAWSJOBPRESIGURLCFG¶
Configuration information for pre-signed URLs. Valid when
protocolscontains HTTP.
IV_TARGETSELECTION TYPE /AWS1/IOTTARGETSELECTION /AWS1/IOTTARGETSELECTION¶
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
IT_OTAUPDATEFILES TYPE /AWS1/CL_IOTOTAUPDATEFILE=>TT_OTAUPDATEFILES TT_OTAUPDATEFILES¶
A list of files associated with the OTA update.
IV_OTAUPDATESTATUS TYPE /AWS1/IOTOTAUPDATESTATUS /AWS1/IOTOTAUPDATESTATUS¶
The status of the OTA update.
IV_AWSIOTJOBID TYPE /AWS1/IOTAWSIOTJOBID /AWS1/IOTAWSIOTJOBID¶
The IoT job ID associated with the OTA update.
IV_AWSIOTJOBARN TYPE /AWS1/IOTAWSIOTJOBARN /AWS1/IOTAWSIOTJOBARN¶
The IoT job ARN associated with the OTA update.
IO_ERRORINFO TYPE REF TO /AWS1/CL_IOTERRORINFO /AWS1/CL_IOTERRORINFO¶
Error information associated with the OTA update.
IT_ADDITIONALPARAMETERS TYPE /AWS1/CL_IOTADDLPARAMETERMAP_W=>TT_ADDITIONALPARAMETERMAP TT_ADDITIONALPARAMETERMAP¶
A collection of name/value pairs
Queryable Attributes¶
otaUpdateId¶
The OTA update ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OTAUPDATEID() |
Getter for OTAUPDATEID, with configurable default |
ASK_OTAUPDATEID() |
Getter for OTAUPDATEID w/ exceptions if field has no value |
HAS_OTAUPDATEID() |
Determine if OTAUPDATEID has a value |
otaUpdateArn¶
The OTA update ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OTAUPDATEARN() |
Getter for OTAUPDATEARN, with configurable default |
ASK_OTAUPDATEARN() |
Getter for OTAUPDATEARN w/ exceptions if field has no value |
HAS_OTAUPDATEARN() |
Determine if OTAUPDATEARN has a value |
creationDate¶
The date when the OTA update was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
lastModifiedDate¶
The date when the OTA update was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
description¶
A description of the OTA update.
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 |
targets¶
The targets of the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETS() |
Getter for TARGETS, with configurable default |
ASK_TARGETS() |
Getter for TARGETS w/ exceptions if field has no value |
HAS_TARGETS() |
Determine if TARGETS has a value |
protocols¶
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROTOCOLS() |
Getter for PROTOCOLS, with configurable default |
ASK_PROTOCOLS() |
Getter for PROTOCOLS w/ exceptions if field has no value |
HAS_PROTOCOLS() |
Determine if PROTOCOLS has a value |
awsJobExecutionsRolloutConfig¶
Configuration for the rollout of OTA updates.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWSJOBEXECSROLLOUTCONFIG() |
Getter for AWSJOBEXECSROLLOUTCONFIG |
awsJobPresignedUrlConfig¶
Configuration information for pre-signed URLs. Valid when
protocolscontains HTTP.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWSJOBPRESIGNEDURLCONFIG() |
Getter for AWSJOBPRESIGNEDURLCONFIG |
targetSelection¶
Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETSELECTION() |
Getter for TARGETSELECTION, with configurable default |
ASK_TARGETSELECTION() |
Getter for TARGETSELECTION w/ exceptions if field has no val |
HAS_TARGETSELECTION() |
Determine if TARGETSELECTION has a value |
otaUpdateFiles¶
A list of files associated with the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OTAUPDATEFILES() |
Getter for OTAUPDATEFILES, with configurable default |
ASK_OTAUPDATEFILES() |
Getter for OTAUPDATEFILES w/ exceptions if field has no valu |
HAS_OTAUPDATEFILES() |
Determine if OTAUPDATEFILES has a value |
otaUpdateStatus¶
The status of the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OTAUPDATESTATUS() |
Getter for OTAUPDATESTATUS, with configurable default |
ASK_OTAUPDATESTATUS() |
Getter for OTAUPDATESTATUS w/ exceptions if field has no val |
HAS_OTAUPDATESTATUS() |
Determine if OTAUPDATESTATUS has a value |
awsIotJobId¶
The IoT job ID associated with the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWSIOTJOBID() |
Getter for AWSIOTJOBID, with configurable default |
ASK_AWSIOTJOBID() |
Getter for AWSIOTJOBID w/ exceptions if field has no value |
HAS_AWSIOTJOBID() |
Determine if AWSIOTJOBID has a value |
awsIotJobArn¶
The IoT job ARN associated with the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWSIOTJOBARN() |
Getter for AWSIOTJOBARN, with configurable default |
ASK_AWSIOTJOBARN() |
Getter for AWSIOTJOBARN w/ exceptions if field has no value |
HAS_AWSIOTJOBARN() |
Determine if AWSIOTJOBARN has a value |
errorInfo¶
Error information associated with the OTA update.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERRORINFO() |
Getter for ERRORINFO |
additionalParameters¶
A collection of name/value pairs
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDITIONALPARAMETERS() |
Getter for ADDITIONALPARAMETERS, with configurable default |
ASK_ADDITIONALPARAMETERS() |
Getter for ADDITIONALPARAMETERS w/ exceptions if field has n |
HAS_ADDITIONALPARAMETERS() |
Determine if ADDITIONALPARAMETERS has a value |