CloudFront / Client / list_field_level_encryption_configs

list_field_level_encryption_configs#

CloudFront.Client.list_field_level_encryption_configs(**kwargs)#

List all field-level encryption configurations that have been created in CloudFront for this account.

See also: AWS API Documentation

Request Syntax

response = client.list_field_level_encryption_configs(
    Marker='string',
    MaxItems='string'
)
Parameters:

  • Marker (string) – Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page’s response (which is also the ID of the last configuration on that page).

  • MaxItems (string) – The maximum number of field-level encryption configurations you want in the response body.

Return type:

dict

Returns:

Response Syntax

{
    'FieldLevelEncryptionList': {
        'NextMarker': 'string',
        'MaxItems': 123,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'LastModifiedTime': datetime(2015, 1, 1),
                'Comment': 'string',
                'QueryArgProfileConfig': {
                    'ForwardWhenQueryArgProfileIsUnknown': True|False,
                    'QueryArgProfiles': {
                        'Quantity': 123,
                        'Items': [
                            {
                                'QueryArg': 'string',
                                'ProfileId': 'string'
                            },
                        ]
                    }
                },
                'ContentTypeProfileConfig': {
                    'ForwardWhenContentTypeIsUnknown': True|False,
                    'ContentTypeProfiles': {
                        'Quantity': 123,
                        'Items': [
                            {
                                'Format': 'URLEncoded',
                                'ProfileId': 'string',
                                'ContentType': 'string'
                            },
                        ]
                    }
                }
            },
        ]
    }
}

Response Structure

  • (dict) –

    • FieldLevelEncryptionList (dict) –

      Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

      • NextMarker (string) –

        If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

      • MaxItems (integer) –

        The maximum number of elements you want in the response body.

      • Quantity (integer) –

        The number of field-level encryption items.

      • Items (list) –

        An array of field-level encryption items.

        • (dict) –

          A summary of a field-level encryption item.

          • Id (string) –

            The unique ID of a field-level encryption item.

          • LastModifiedTime (datetime) –

            The last time that the summary of field-level encryption items was modified.

          • Comment (string) –

            An optional comment about the field-level encryption item. The comment cannot be longer than 128 characters.

          • QueryArgProfileConfig (dict) –

            A summary of a query argument-profile mapping.

            • ForwardWhenQueryArgProfileIsUnknown (boolean) –

              Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

            • QueryArgProfiles (dict) –

              Profiles specified for query argument-profile mapping for field-level encryption.

              • Quantity (integer) –

                Number of profiles for query argument-profile mapping for field-level encryption.

              • Items (list) –

                Number of items for query argument-profile mapping for field-level encryption.

                • (dict) –

                  Query argument-profile mapping for field-level encryption.

                  • QueryArg (string) –

                    Query argument for field-level encryption query argument-profile mapping.

                  • ProfileId (string) –

                    ID of profile to use for field-level encryption query argument-profile mapping

          • ContentTypeProfileConfig (dict) –

            A summary of a content type-profile mapping.

            • ForwardWhenContentTypeIsUnknown (boolean) –

              The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

            • ContentTypeProfiles (dict) –

              The configuration for a field-level encryption content type-profile.

              • Quantity (integer) –

                The number of field-level encryption content type-profile mappings.

              • Items (list) –

                Items in a field-level encryption content type-profile mapping.

                • (dict) –

                  A field-level encryption content type profile.

                  • Format (string) –

                    The format for a field-level encryption content type-profile mapping.

                  • ProfileId (string) –

                    The profile ID for a field-level encryption content type-profile mapping.

                  • ContentType (string) –

                    The content type for a field-level encryption content type-profile mapping.

Exceptions