GetFieldLevelEncryptionCommand

Suggest an Edit

Get the field-level encryption configuration information.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFrontClient, GetFieldLevelEncryptionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
// const { CloudFrontClient, GetFieldLevelEncryptionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
const client = new CloudFrontClient(config);
const input = { // GetFieldLevelEncryptionRequest
  Id: "STRING_VALUE", // required
};
const command = new GetFieldLevelEncryptionCommand(input);
const response = await client.send(command);
// { // GetFieldLevelEncryptionResult
//   FieldLevelEncryption: { // FieldLevelEncryption
//     Id: "STRING_VALUE", // required
//     LastModifiedTime: new Date("TIMESTAMP"), // required
//     FieldLevelEncryptionConfig: { // FieldLevelEncryptionConfig
//       CallerReference: "STRING_VALUE", // required
//       Comment: "STRING_VALUE",
//       QueryArgProfileConfig: { // QueryArgProfileConfig
//         ForwardWhenQueryArgProfileIsUnknown: true || false, // required
//         QueryArgProfiles: { // QueryArgProfiles
//           Quantity: Number("int"), // required
//           Items: [ // QueryArgProfileList
//             { // QueryArgProfile
//               QueryArg: "STRING_VALUE", // required
//               ProfileId: "STRING_VALUE", // required
//             },
//           ],
//         },
//       },
//       ContentTypeProfileConfig: { // ContentTypeProfileConfig
//         ForwardWhenContentTypeIsUnknown: true || false, // required
//         ContentTypeProfiles: { // ContentTypeProfiles
//           Quantity: Number("int"), // required
//           Items: [ // ContentTypeProfileList
//             { // ContentTypeProfile
//               Format: "URLEncoded", // required
//               ProfileId: "STRING_VALUE",
//               ContentType: "STRING_VALUE", // required
//             },
//           ],
//         },
//       },
//     },
//   },
//   ETag: "STRING_VALUE",
// };

GetFieldLevelEncryptionCommand Input

See GetFieldLevelEncryptionCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

Request the ID for the field-level encryption configuration information.

GetFieldLevelEncryptionCommand Output

See GetFieldLevelEncryptionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ETag
string | undefined

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

FieldLevelEncryption
FieldLevelEncryption | undefined

Return the field-level encryption configuration information.

Throws

Name
Fault
Details
AccessDenied
client

Access denied.

NoSuchFieldLevelEncryptionConfig
client

The specified configuration for field-level encryption doesn't exist.

CloudFrontServiceException
Base exception class for all service exceptions from CloudFront service.