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

***********************
update_key_registration
***********************



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

  

  Updates a customer managed key in a Quick Sight account.

  

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


  **Request Syntax**
  ::

    response = client.update_key_registration(
        AwsAccountId='string',
        KeyRegistration=[
            {
                'KeyArn': 'string',
                'DefaultKey': 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 update.

    

  
  :type KeyRegistration: list
  :param KeyRegistration: **[REQUIRED]** 

    A list of ``RegisteredCustomerManagedKey`` objects to be updated to the 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.

        

      
    

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

    
    ::

      {
          'FailedKeyRegistration': [
              {
                  'KeyArn': 'string',
                  'Message': 'string',
                  'StatusCode': 123,
                  'SenderFault': True|False
              },
          ],
          'SuccessfulKeyRegistration': [
              {
                  'KeyArn': 'string',
                  'StatusCode': 123
              },
          ],
          'RequestId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FailedKeyRegistration** *(list) --* 

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

        
        

        - *(dict) --* 

          An entry that appears when a ``KeyRegistration`` update to Quick Sight fails.

          
          

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

            The ARN of the KMS key that failed to update.

            
          

          - **Message** *(string) --* 

            A message that provides information about why a ``FailedKeyRegistrationEntry`` error occurred.

            
          

          - **StatusCode** *(integer) --* 

            The HTTP status of a ``FailedKeyRegistrationEntry`` error.

            
          

          - **SenderFault** *(boolean) --* 

            A boolean that indicates whether a ``FailedKeyRegistrationEntry`` resulted from user error. If the value of this property is ``True``, the error was caused by user error. If the value of this property is ``False``, the error occurred on the backend. If your job continues fail and with a ``False`` ``SenderFault`` value, contact Amazon Web Services Support.

            
      
    
      

      - **SuccessfulKeyRegistration** *(list) --* 

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

        
        

        - *(dict) --* 

          A success entry that occurs when a ``KeyRegistration`` job is successfully applied to the Quick Sight account.

          
          

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

            The ARN of the KMS key that is associated with the ``SuccessfulKeyRegistrationEntry`` entry.

            
          

          - **StatusCode** *(integer) --* 

            The HTTP status of a ``SuccessfulKeyRegistrationEntry`` entry.

            
      
    
      

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

        The Amazon Web Services request ID for this operation.

        
  
  **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`

  