get_field_level_encryption_profile_config

CloudFront.Client.get_field_level_encryption_profile_config(**kwargs)

Get the field-level encryption profile configuration information.

See also: AWS API Documentation

Request Syntax

response = client.get_field_level_encryption_profile_config(
    Id='string'
)

Parameters

Id (string) --

[REQUIRED]

Get the ID for the field-level encryption profile configuration information.

Return type

dict

Returns

Response Syntax

{
    'FieldLevelEncryptionProfileConfig': {
        'Name': 'string',
        'CallerReference': 'string',
        'Comment': 'string',
        'EncryptionEntities': {
            'Quantity': 123,
            'Items': [
                {
                    'PublicKeyId': 'string',
                    'ProviderId': 'string',
                    'FieldPatterns': {
                        'Quantity': 123,
                        'Items': [
                            'string',
                        ]
                    }
                },
            ]
        }
    },
    'ETag': 'string'
}

Response Structure

• (dict) --
  • FieldLevelEncryptionProfileConfig (dict) --

    Return the field-level encryption profile configuration information.

    • 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 (dict) --

      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.

        • (dict) --

          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 (dict) --

            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 configuration result. For example: E2QWRUHAPOMQZL .

Exceptions

• CloudFront.Client.exceptions.AccessDenied
• CloudFront.Client.exceptions.NoSuchFieldLevelEncryptionProfile