IoTFleetWise / Client / get_encryption_configuration

get_encryption_configuration#

IoTFleetWise.Client.get_encryption_configuration()#

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

Request Syntax

response = client.get_encryption_configuration()

Return type:

dict

Returns:

Response Syntax

{
    'kmsKeyId': 'string',
    'encryptionStatus': 'PENDING'|'SUCCESS'|'FAILURE',
    'encryptionType': 'KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION',
    'errorMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

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.
- errorMessage (string) –
  
  The error message that describes why encryption settings couldn’t be configured, if applicable.
- creationTime (datetime) –
  
  The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
- lastModificationTime (datetime) –
  
  The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Exceptions

IoTFleetWise.Client.exceptions.ResourceNotFoundException
IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException