[ aws . xray ]

get-encryption-config

Description

Retrieves the current encryption configuration for X-Ray data.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-encryption-config
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve the encryption configuration

The following get-encryption-config example retrieves the current encryption configuration for your AWS X-Ray data.

aws xray get-encryption-config

Output:

{
    "EncryptionConfig": {
        "KeyId": "ae4aa6d49-a4d8-9df9-a475-4ff6d7898456",
        "Status": "ACTIVE",
        "Type": "NONE"
    }
}

For more information, see Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API in the AWS X-Ray Developer Guide.

Output

EncryptionConfig -> (structure)

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.