CloudFront / Client / get_key_group_config

get_key_group_config#

CloudFront.Client.get_key_group_config(**kwargs)#

Gets a key group configuration.

To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.

See also: AWS API Documentation

Request Syntax

response = client.get_key_group_config(
    Id='string'
)
Parameters:

Id (string) –

[REQUIRED]

The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.

Return type:

dict

Returns:

Response Syntax

{
    'KeyGroupConfig': {
        'Name': 'string',
        'Items': [
            'string',
        ],
        'Comment': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • KeyGroupConfig (dict) –

      The key group configuration.

      • Name (string) –

        A name to identify the key group.

      • Items (list) –

        A list of the identifiers of the public keys in the key group.

        • (string) –

      • Comment (string) –

        A comment to describe the key group. The comment cannot be longer than 128 characters.

    • ETag (string) –

      The identifier for this version of the key group.

Exceptions

  • CloudFront.Client.exceptions.NoSuchResource