ConfigurationDetails - Amazon IoT
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ConfigurationDetails

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

Contents

configurationStatus

The health status of KMS key and Amazon KMS access role. If either KMS key or Amazon 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.

Type: String

Valid Values: HEALTHY | UNHEALTHY

Required: No

errorCode

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

Type: String

Required: No

errorMessage

The detailed error message that corresponds to the errorCode.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

See Also

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