AWS IoT FleetWise

2023/09/28 - AWS IoT FleetWise - 2 new api methods

Changes  AWS IoT FleetWise now supports encryption through a customer managed AWS KMS key. The PutEncryptionConfiguration and GetEncryptionConfiguration APIs were added.

PutEncryptionConfiguration (new) Link ¶

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

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.

GetEncryptionConfiguration (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_encryption_configuration()
rtype:

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).