IoTFleetWise / Client / put_encryption_configuration
put_encryption_configuration#
- 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 in the Amazon Web Services IoT FleetWise Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.put_encryption_configuration( kmsKeyId='string', encryptionType='KMS_BASED_ENCRYPTION'|'FLEETWISE_DEFAULT_ENCRYPTION' )
- Parameters:
kmsKeyId (string) – The ID of the KMS key that is used for encryption.
encryptionType (string) –
[REQUIRED]
The type of encryption. Choose
KMS_BASED_ENCRYPTION
to use a KMS key orFLEETWISE_DEFAULT_ENCRYPTION
to use an Amazon Web Services managed key.
- Return type:
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 toFLEETWISE_DEFAULT_ENCRYPTION
to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
Exceptions
IoTFleetWise.Client.exceptions.ResourceNotFoundException
IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.ConflictException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException