Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cloudfront ]
get-field-level-encryption-profile¶
Synopsis¶
get-field-level-encryption-profile
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--id (string)
Get the ID for the field-level encryption profile information.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get a CloudFront field-level encryption profile
The following example gets the CloudFront field-level encryption profile with
ID PPK0UOSIF5WSV , including its ETag:
aws cloudfront get-field-level-encryption-profile --id PPK0UOSIF5WSV
Output:
{
"ETag": "E1QQG65FS2L2GC",
"FieldLevelEncryptionProfile": {
"Id": "PPK0UOSIF5WSV",
"LastModifiedTime": "2019-12-10T01:03:16.537Z",
"FieldLevelEncryptionProfileConfig": {
"Name": "ExampleFLEProfile",
"CallerReference": "cli-example",
"Comment": "FLE profile for AWS CLI example",
"EncryptionEntities": {
"Quantity": 1,
"Items": [
{
"PublicKeyId": "K2K8NC4HVFE3M0",
"ProviderId": "ExampleFLEProvider",
"FieldPatterns": {
"Quantity": 1,
"Items": [
"ExampleSensitiveField"
]
}
}
]
}
}
}
}
Output¶
FieldLevelEncryptionProfile -> (structure)
Return the field-level encryption profile information.
Id -> (string)
The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.LastModifiedTime -> (timestamp)
The last time the field-level encryption profile was updated.FieldLevelEncryptionProfileConfig -> (structure)
A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
Name -> (string)
Profile name for the field-level encryption profile.CallerReference -> (string)
A unique number that ensures that the request can't be replayed.Comment -> (string)
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.EncryptionEntities -> (structure)
A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
Quantity -> (integer)
Number of field pattern items in a field-level encryption content type-profile mapping.Items -> (list)
An array of field patterns in a field-level encryption content type-profile mapping.
(structure)
Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
PublicKeyId -> (string)
The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.ProviderId -> (string)
The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.FieldPatterns -> (structure)
Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
Quantity -> (integer)
The number of field-level encryption field patterns.Items -> (list)
An array of the field-level encryption field patterns.
(string)
ETag -> (string)
The current version of the field level encryption profile. For example:E2QWRUHAPOMQZL.