Boto3 Docs 1.26.93 documentation

get_encryption_config¶

XRay.Client.get_encryption_config()¶

Retrieves the current encryption configuration for X-Ray data.

See also: AWS API Documentation

Request Syntax

response = client.get_encryption_config()

Return type

dict

Returns

Response Syntax

{
    'EncryptionConfig': {
        'KeyId': 'string',
        'Status': 'UPDATING'|'ACTIVE',
        'Type': 'NONE'|'KMS'
    }
}

Response Structure

(dict) --
- EncryptionConfig (dict) --
  The encryption configuration document.
  - KeyId (string) --
    The ID of the KMS key used for encryption, if applicable.
  - Status (string) --
    The encryption status. While the status is UPDATING , X-Ray may encrypt data with a combination of the new and old settings.
  - Type (string) --
    The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

Exceptions

XRay.Client.exceptions.InvalidRequestException
XRay.Client.exceptions.ThrottledException