put_encryption_config

XRay.Client.put_encryption_config(**kwargs)

Updates the encryption configuration for X-Ray data.

See also: AWS API Documentation

Request Syntax

response = client.put_encryption_config(
    KeyId='string',
    Type='NONE'|'KMS'
)

Parameters

• KeyId (string) --

  An Amazon Web Services KMS key in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey .
  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . Amazon Web Services X-Ray does not support asymmetric KMS keys.
  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . Use this format to specify a key in a different account.

  Omit this key if you set Type to NONE .

• Type (string) --

  [REQUIRED]

  The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • EncryptionConfig (dict) --

    The new encryption configuration.

    • 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