UpdateKeyRegistration - Amazon QuickSight


Updates a customer managed key in a Amazon QuickSight account.

Request Syntax

POST /accounts/AwsAccountId/key-registration HTTP/1.1 Content-type: application/json { "KeyRegistration": [ { "DefaultKey": boolean, "KeyArn": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


The ID of the AWS account that contains the customer managed key registration that you want to update.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

Type: Array of RegisteredCustomerManagedKey objects

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "FailedKeyRegistration": [ { "KeyArn": "string", "Message": "string", "SenderFault": boolean, "StatusCode": number } ], "RequestId": "string", "SuccessfulKeyRegistration": [ { "KeyArn": "string", "StatusCode": number } ] }

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.


A list of all customer managed key registrations that failed to update.

Type: Array of FailedKeyRegistrationEntry objects


The AWS request ID for this operation.

Type: String

Pattern: .*\S.*


A list of all customer managed key registrations that were successfully updated.

Type: Array of SuccessfulKeyRegistrationEntry objects


For information about the errors that are common to all actions, see Common Errors.


You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401


An internal failure occurred.

HTTP Status Code: 500


One or more parameters has a value that isn't valid.

HTTP Status Code: 400


Access is throttled.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: