Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PutEncryptionConfiguration

Creates or updates the encryption configuration. AWS IoT FleetWise can encrypt your data and resources using an AWS managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the AWS IoT FleetWise Developer Guide.

Request Syntax


{
   "encryptionType": "string",
   "kmsKeyId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

encryptionType

The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION to use an AWS managed key.

Type: String

Valid Values: KMS_BASED_ENCRYPTION | FLEETWISE_DEFAULT_ENCRYPTION

Required: Yes

kmsKeyId

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

Type: String

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

Required: No

Response Syntax


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

encryptionStatus

The encryption status.

Type: String

Valid Values: PENDING | SUCCESS | FAILURE

encryptionType

The type of encryption. Set to KMS_BASED_ENCRYPTION to use an 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

kmsKeyId

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

Type: String

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

ConflictException

The 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.

resource: The resource on which there are conflicting operations.
resourceType: The type of resource on which there are conflicting operations..

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