PutEncryptionConfig
Updates the encryption configuration for X-Ray data.
Request Syntax
POST /PutEncryptionConfig HTTP/1.1
Content-type: application/json
{
"KeyId": "string
",
"Type": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- KeyId
-
An Amazon 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 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
toNONE
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Required: No
-
- Type
-
The type of encryption. Set to
KMS
to use your own key for encryption. Set toNONE
for default encryption.Type: String
Valid Values:
NONE | KMS
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EncryptionConfig": {
"KeyId": "string",
"Status": "string",
"Type": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EncryptionConfig
-
The new encryption configuration.
Type: EncryptionConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidRequestException
-
The request is missing required parameters or has invalid parameters.
HTTP Status Code: 400
- ThrottledException
-
The request exceeds the maximum number of requests per second.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: