Skip to content

ConfigurationDetails

Source code in docs_src/capo_iot/types/configuration_details.py 
13
14
15
16
17
18
19
20
21
class ConfigurationDetails(TypedDict, closed=True):
    configuration_status: NotRequired[
        "capo_iot.types.configuration_status.ConfigurationStatus"
    ]
    """<p>The health status of KMS key and KMS access role. If either KMS key or KMS access role is <code>UNHEALTHY</code>, the return value will be <code>UNHEALTHY</code>. To use a customer managed KMS key, the value of <code>configurationStatus</code> must be <code>HEALTHY</code>. </p>"""
    error_code: NotRequired["capo_iot.types.error_code.ErrorCode"]
    """<p>The error code that indicates either the KMS key or the KMS access role is <code>UNHEALTHY</code>. Valid values: <code>KMS_KEY_VALIDATION_ERROR</code> and <code>ROLE_VALIDATION_ERROR</code>. </p>"""
    error_message: NotRequired["capo_iot.types.error_message.ErrorMessage"]
    """<p>The detailed error message that corresponds to the <code>errorCode</code>.</p>"""

configuration_status instance-attribute 

configuration_status: NotRequired[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.

error_code instance-attribute 

error_code: NotRequired[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.

error_message instance-attribute 

error_message: NotRequired[ErrorMessage]

The detailed error message that corresponds to the errorCode.