PutDefaultEncryptionConfiguration - AWS IoT SiteWise

PutDefaultEncryptionConfiguration

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

Request Syntax

POST /configuration/account/encryption HTTP/1.1 Content-type: application/json { "encryptionType": "string", "kmsKeyId": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

encryptionType

The type of encryption used for the encryption configuration.

Type: String

Valid Values: SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION

Required: Yes

kmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "configurationStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }, "encryptionType": "string", "kmsKeyArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configurationStatus

The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails.

Type: ConfigurationStatus object

encryptionType

The type of encryption used for the encryption configuration.

Type: String

Valid Values: SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION

kmsKeyArn

The Key ARN of the AWS KMS key used for AWS KMS encryption if you use KMS_BASED_ENCRYPTION.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

LimitExceededException

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 410

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: