:doc:`IoTSiteWise <../../iotsitewise>` / Client / describe_default_encryption_configuration

*****************************************
describe_default_encryption_configuration
*****************************************



.. py:method:: IoTSiteWise.Client.describe_default_encryption_configuration()

  

  Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see `Key management <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html>`__ in the *IoT SiteWise User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration>`_  


  **Request Syntax**
  ::

    response = client.describe_default_encryption_configuration()
    
    
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
          'kmsKeyArn': 'string',
          'configurationStatus': {
              'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
              'error': {
                  'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                  'message': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **encryptionType** *(string) --* 

        The type of encryption used for the encryption configuration.

        
      

      - **kmsKeyArn** *(string) --* 

        The key ARN of the customer managed key used for KMS encryption if you use ``KMS_BASED_ENCRYPTION``.

        
      

      - **configurationStatus** *(dict) --* 

        The status of the account configuration. This contains the ``ConfigurationState``. If there's an error, it also contains the ``ErrorDetails``.

        
        

        - **state** *(string) --* 

          The current state of the configuration.

          
        

        - **error** *(dict) --* 

          Contains associated error information, if any.

          
          

          - **code** *(string) --* 

            The error code.

            
          

          - **message** *(string) --* 

            The error message.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

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

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

  