:doc:`IoTFleetWise <../../iotfleetwise>` / Client / put_encryption_configuration

****************************
put_encryption_configuration
****************************



.. py:method:: IoTFleetWise.Client.put_encryption_configuration(**kwargs)

  

  Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see `Data encryption <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html>`__ in the *Amazon Web Services IoT FleetWise Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/PutEncryptionConfiguration>`_  


  **Request Syntax**
  ::

    response = client.put_encryption_configuration(
        kmsKeyId='string',
        encryptionType='KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION'
    )
    
  :type kmsKeyId: string
  :param kmsKeyId: 

    The ID of the KMS key that is used for encryption.

    

  
  :type encryptionType: string
  :param encryptionType: **[REQUIRED]** 

    The type of encryption. Choose ``KMS_BASED_ENCRYPTION`` to use a KMS key or ``FLEETWISE_DEFAULT_ENCRYPTION`` to use an Amazon Web Services managed key.

    

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

    
    ::

      {
          'kmsKeyId': 'string',
          'encryptionStatus': 'PENDING'|'SUCCESS'|'FAILURE',
          'encryptionType': 'KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **kmsKeyId** *(string) --* 

        The ID of the KMS key that is used for encryption.

        
      

      - **encryptionStatus** *(string) --* 

        The encryption status.

        
      

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

        The type of encryption. Set to ``KMS_BASED_ENCRYPTION`` to use an KMS key that you own and manage. Set to ``FLEETWISE_DEFAULT_ENCRYPTION`` to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.

        
  
  **Exceptions**
  
  *   :py:class:`IoTFleetWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.InternalServerException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ConflictException`

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

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.AccessDeniedException`

  