Skip to content

/AWS1/CL_IOTCONFDETAILS

The encryption configuration details that include the status information of the Amazon Web Services Key Management Service (KMS) key and the KMS access role.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_configurationstatus TYPE /AWS1/IOTCONFIGURATIONSTATUS /AWS1/IOTCONFIGURATIONSTATUS

The health status of KMS key and KMS access role. If either KMS key or KMS access role is UNHEALTHY, the return value will be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.

iv_errorcode TYPE /AWS1/IOTERRORCODE /AWS1/IOTERRORCODE

The error code that indicates either the KMS key or the KMS access role is UNHEALTHY. Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR.

iv_errormessage TYPE /AWS1/IOTERRORMESSAGE /AWS1/IOTERRORMESSAGE

The detailed error message that corresponds to the errorCode.

Queryable Attributes

configurationStatus

The health status of KMS key and KMS access role. If either KMS key or KMS access role is UNHEALTHY, the return value will be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.

Accessible with the following methods

Method Description
GET_CONFIGURATIONSTATUS() Getter for CONFIGURATIONSTATUS, with configurable default
ASK_CONFIGURATIONSTATUS() Getter for CONFIGURATIONSTATUS w/ exceptions if field has no
HAS_CONFIGURATIONSTATUS() Determine if CONFIGURATIONSTATUS has a value

errorCode

The error code that indicates either the KMS key or the KMS access role is UNHEALTHY. Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR.

Accessible with the following methods

Method Description
GET_ERRORCODE() Getter for ERRORCODE, with configurable default
ASK_ERRORCODE() Getter for ERRORCODE w/ exceptions if field has no value
HAS_ERRORCODE() Determine if ERRORCODE has a value

errorMessage

The detailed error message that corresponds to the errorCode.

Accessible with the following methods

Method Description
GET_ERRORMESSAGE() Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE() Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE() Determine if ERRORMESSAGE has a value