Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . xray ]



Updates the encryption configuration for X-Ray data.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--key-id <value>]
--type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--key-id (string)

An AWS KMS customer master key (CMK) 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 .
  • 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)

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

Possible values:

  • NONE
  • KMS

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


EncryptionConfig -> (structure)

The new encryption configuration.

KeyId -> (string)

The ID of the customer master key (CMK) used for encryption, if applicable.

Status -> (string)

The encryption status. After modifying encryption configuration with PutEncryptionConfig , the status can be UPDATING for up to one hour before X-Ray starts encrypting data with the new key.

Type -> (string)

The type of encryption. Set to KMS for encryption with CMKs. Set to NONE for default encryption.