DescribeDefaultEncryptionConfiguration
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.
Request Syntax
GET /configuration/account/encryption HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
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's an error, it also contains theErrorDetails.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 customer managed 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:
^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- 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:
