- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetEncryptionConfigurationCommand
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTFleetWiseClient, GetEncryptionConfigurationCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
// const { IoTFleetWiseClient, GetEncryptionConfigurationCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
const client = new IoTFleetWiseClient(config);
const input = {};
const command = new GetEncryptionConfigurationCommand(input);
const response = await client.send(command);
// { // GetEncryptionConfigurationResponse
// kmsKeyId: "STRING_VALUE",
// encryptionStatus: "PENDING" || "SUCCESS" || "FAILURE", // required
// encryptionType: "KMS_BASED_ENCRYPTION" || "FLEETWISE_DEFAULT_ENCRYPTION", // required
// errorMessage: "STRING_VALUE",
// creationTime: new Date("TIMESTAMP"),
// lastModificationTime: new Date("TIMESTAMP"),
// };
GetEncryptionConfigurationCommand Input
GetEncryptionConfigurationCommandInput extends GetEncryptionConfigurationRequest GetEncryptionConfigurationCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
encryptionStatusRequired | EncryptionStatus | undefined | The encryption status. |
encryptionTypeRequired | EncryptionType | undefined | The type of encryption. Set to |
creationTime | Date | undefined | The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time). |
errorMessage | string | undefined | The error message that describes why encryption settings couldn't be configured, if applicable. |
kmsKeyId | string | undefined | The ID of the KMS key that is used for encryption. |
lastModificationTime | Date | undefined | The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You don't have sufficient permission to perform this action. |
| InternalServerException | server | The request couldn't be completed because the server temporarily failed. |
| ResourceNotFoundException | client | The resource wasn't found. |
| ThrottlingException | client | The request couldn't be completed due to throttling. |
| ValidationException | client | The input fails to satisfy the constraints specified by an Amazon Web Services service. |
| IoTFleetWiseServiceException | Base exception class for all service exceptions from IoTFleetWise service. |