Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeEncryptionConfiguration

Retrieves the encryption configuration for resources and data of your AWS account in AWS IoT Core. For more information, see Data encryption at rest in the AWS IoT Core Developer Guide.

Request Syntax


GET /encryption-configuration 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

{
   "configurationDetails": { 
      "configurationStatus": "string",
      "errorCode": "string",
      "errorMessage": "string"
   },
   "encryptionType": "string",
   "kmsAccessRoleArn": "string",
   "kmsKeyArn": "string",
   "lastModifiedDate": number
}

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.

configurationDetails

The encryption configuration details that include the status information of the KMS key and the AWS KMS access role.

Type: ConfigurationDetails object

encryptionType

The type of the KMS key.

Type: String

Valid Values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY

kmsAccessRoleArn

The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.

Type: String

Length Constraints: Maximum length of 2048.

kmsKeyArn

The ARN of the customer managed KMS key.

Type: String

Length Constraints: Maximum length of 2048.

lastModifiedDate

The date when encryption configuration is last updated.

Type: Timestamp

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401