:doc:`QuickSight <../../quicksight>` / Client / describe_key_registration

*************************
describe_key_registration
*************************



.. py:method:: QuickSight.Client.describe_key_registration(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeKeyRegistration>`_  


  **Request Syntax**
  ::

    response = client.describe_key_registration(
        AwsAccountId='string',
        DefaultKeyOnly=True|False
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

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

    

  
  :type DefaultKeyOnly: boolean
  :param DefaultKeyOnly: 

    Determines whether the request returns the default key only.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AwsAccountId': 'string',
          'KeyRegistration': [
              {
                  'KeyArn': 'string',
                  'DefaultKey': True|False
              },
          ],
          'QDataKey': {
              'QDataKeyArn': 'string',
              'QDataKeyType': 'AWS_OWNED'|'CMK'
          },
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AwsAccountId** *(string) --* 

        The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

        
      

      - **KeyRegistration** *(list) --* 

        A list of ``RegisteredCustomerManagedKey`` objects in a Quick Sight account.

        
        

        - *(dict) --* 

          A customer managed key structure that contains the information listed below:

           

          
          * ``KeyArn`` - The ARN of a KMS key that is registered to a Quick Sight account for encryption and decryption use.
           
          * ``DefaultKey`` - Indicates whether the current key is set as the default key for encryption and decryption use.
          

          
          

          - **KeyArn** *(string) --* 

            The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use.

            
          

          - **DefaultKey** *(boolean) --* 

            Indicates whether a ``RegisteredCustomerManagedKey`` is set as the default key for encryption and decryption use.

            
      
    
      

      - **QDataKey** *(dict) --* 

        A list of ``QDataKey`` objects in a Quick Sight account.

        
        

        - **QDataKeyArn** *(string) --* 

          The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use as a ``QDataKey``.

          
        

        - **QDataKeyType** *(string) --* 

          The type of ``QDataKey``.

          
    
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  