Response Syntax Response Elements Errors See Also

GetEncryptionConfiguration

Retrieves the encryption configuration for resources and data in AWS IoT FleetWise.

Response Syntax


{
   "creationTime": number,
   "encryptionStatus": "string",
   "encryptionType": "string",
   "errorMessage": "string",
   "kmsKeyId": "string",
   "lastModificationTime": 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.

creationTime

The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

encryptionStatus

The encryption status.

Type: String

Valid Values: PENDING | SUCCESS | FAILURE

encryptionType

The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an AWS managed key that is owned by the AWS IoT FleetWise service account.

Type: String

Valid Values: KMS_BASED_ENCRYPTION | FLEETWISE_DEFAULT_ENCRYPTION

errorMessage

The error message that describes why encryption settings couldn't be configured, if applicable.

Type: String

kmsKeyId

The ID of the KMS key that is used for encryption.

Type: String

lastModificationTime

The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Type: Timestamp

Errors

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

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

retryAfterSeconds: The number of seconds to wait before retrying the command.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

quotaCode: The quota identifier of the applied throttling rules for this request.
retryAfterSeconds: The number of seconds to wait before retrying the command.
serviceCode: The code for the service that couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The list of fields that fail to satisfy the constraints specified by an AWS service.
reason: The reason the input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400