# DescribeKeyRegistration
<a name="API_DescribeKeyRegistration"></a>

Describes all customer managed key registrations in a Quick Sight account.

## Request Syntax
<a name="API_DescribeKeyRegistration_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_DescribeKeyRegistration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AwsAccountId](#API_DescribeKeyRegistration_RequestSyntax) **   <a name="QS-DescribeKeyRegistration-request-uri-AwsAccountId"></a>
The ID of the Amazon 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](#API_DescribeKeyRegistration_RequestSyntax) **   <a name="QS-DescribeKeyRegistration-request-uri-DefaultKeyOnly"></a>
Determines whether the request returns the default key only.

## Request Body
<a name="API_DescribeKeyRegistration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeKeyRegistration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AwsAccountId": "string",
   "KeyRegistration": [ 
      { 
         "DefaultKey": boolean,
         "KeyArn": "string"
      }
   ],
   "QDataKey": { 
      "QDataKeyArn": "string",
      "QDataKeyType": "string"
   },
   "RequestId": "string",
   "Status": number
}
```

## Response Elements
<a name="API_DescribeKeyRegistration_ResponseElements"></a>

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](#API_DescribeKeyRegistration_ResponseSyntax) **   <a name="QS-DescribeKeyRegistration-response-AwsAccountId"></a>
The ID of the Amazon 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](#API_DescribeKeyRegistration_ResponseSyntax) **   <a name="QS-DescribeKeyRegistration-response-KeyRegistration"></a>
A list of `RegisteredCustomerManagedKey` objects in a Quick Sight account.  
Type: Array of [RegisteredCustomerManagedKey](API_RegisteredCustomerManagedKey.md) objects

 ** [QDataKey](#API_DescribeKeyRegistration_ResponseSyntax) **   <a name="QS-DescribeKeyRegistration-response-QDataKey"></a>
A list of `QDataKey` objects in a Quick Sight account.  
Type: [QDataKey](API_QDataKey.md) object

 ** [RequestId](#API_DescribeKeyRegistration_ResponseSyntax) **   <a name="QS-DescribeKeyRegistration-response-RequestId"></a>
The Amazon request ID for this operation.  
Type: String  
Pattern: `.*\S.*` 

 ** [Status](#API_DescribeKeyRegistration_ResponseSyntax) **   <a name="QS-DescribeKeyRegistration-response-Status"></a>
The HTTP status of the request.  
Type: Integer

## Errors
<a name="API_DescribeKeyRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.    
 ** RequestId **   
The Amazon request ID for this request.
HTTP Status Code: 401

 ** InternalFailureException **   
An internal failure occurred.    
 ** RequestId **   
The Amazon request ID for this request.
HTTP Status Code: 500

 ** InvalidParameterValueException **   
One or more parameters has a value that isn't valid.    
 ** RequestId **   
The Amazon request ID for this request.
HTTP Status Code: 400

 ** ThrottlingException **   
Access is throttled.    
 ** RequestId **   
The Amazon request ID for this request.
HTTP Status Code: 429

## See Also
<a name="API_DescribeKeyRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/quicksight-2018-04-01/DescribeKeyRegistration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeKeyRegistration)