Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeKeyRegistration

Describes all customer managed key registrations in a Amazon QuickSight account.

Request Syntax


GET /accounts/AwsAccountId/key-registration?default-key-only=DefaultKeyOnly HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

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

Length Constraints: Fixed length of 12.

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

Required: Yes

DefaultKeyOnly

Determines whether the request returns the default key only.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AwsAccountId": "string",
   "KeyRegistration": [ 
      { 
         "DefaultKey": boolean,
         "KeyArn": "string"
      }
   ],
   "RequestId": "string",
   "Status": 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.

AwsAccountId

The ID of the AWS account that contains the customer managed key registration specified in the request.

Type: String

Length Constraints: Fixed length of 12.

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

KeyRegistration

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

Type: Array of RegisteredCustomerManagedKey objects

RequestId

The AWS request ID for this operation.

Type: String

Pattern: .*\S.*

Status

The HTTP status of the request.

Type: Integer

Errors

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

AccessDeniedException

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

ThrottlingException

Access is throttled.

HTTP Status Code: 429