ManagedintegrationsforIoTDeviceManagement / Client / get_default_encryption_configuration

get_default_encryption_configuration#

ManagedintegrationsforIoTDeviceManagement.Client.get_default_encryption_configuration()#

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_default_encryption_configuration()
Return type:

dict

Returns:

Response Syntax

{
    'configurationStatus': {
        'error': {
            'code': 'string',
            'message': 'string'
        },
        'state': 'ENABLED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
    },
    'encryptionType': 'MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION',
    'kmsKeyArn': 'string'
}

Response Structure

  • (dict) –

    • configurationStatus (dict) –

      Provides the status of the default encryption configuration for an Amazon Web Services account.

      • error (dict) –

        The error details describing a failed default encryption configuration update.

        • code (string) –

          The error code returned when the default encryption configuration update fails.

        • message (string) –

          The error message returned when the default encryption configuration update fails.

      • state (string) –

        The status state describing the default encryption configuration update.

    • encryptionType (string) –

      The type of encryption used for the encryption configuration.

    • kmsKeyArn (string) –

      The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

Exceptions