AWS API Changes

2020/11/24 - AWS IoT SiteWise - 2 new api methods

Changes This release adds support for customer managed customer master key (CMK) based encryption in IoT SiteWise.

PutDefaultEncryptionConfiguration (new)

Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

client.put_default_encryption_configuration(
    encryptionType='SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
    kmsKeyId='string'
)

type encryptionType

string

param encryptionType

[REQUIRED]

The type of encryption used for the encryption configuration.

type kmsKeyId

string

param kmsKeyId

The Key ID of the customer managed customer master key (CMK) used for AWS KMS encryption. This is required if you use KMS_BASED_ENCRYPTION .

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 AWS KMS CMK used for AWS KMS encryption if you use KMS_BASED_ENCRYPTION .
- configurationStatus (dict) --
  
  The status of the account configuration. This contains the ConfigurationState . If there is an error, it also contains the ErrorDetails .
  - state (string) --
  - error (dict) --
    - code (string) --
    - message (string) --

DescribeDefaultEncryptionConfiguration (new)

Link ¶

Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide .