CloudFront / Client / list_key_groups

list_key_groups#

CloudFront.Client.list_key_groups(**kwargs)#

Gets a list of key groups.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

See also: AWS API Documentation

Request Syntax

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

  • Marker (string) – Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

  • MaxItems (string) – The maximum number of key groups that you want in the response.

Return type:

dict

Returns:

Response Syntax

{
    'KeyGroupList': {
        'NextMarker': 'string',
        'MaxItems': 123,
        'Quantity': 123,
        'Items': [
            {
                'KeyGroup': {
                    'Id': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'KeyGroupConfig': {
                        'Name': 'string',
                        'Items': [
                            'string',
                        ],
                        'Comment': 'string'
                    }
                }
            },
        ]
    }
}

Response Structure

  • (dict) –

    • KeyGroupList (dict) –

      A list of key groups.

      • NextMarker (string) –

        If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.

      • MaxItems (integer) –

        The maximum number of key groups requested.

      • Quantity (integer) –

        The number of key groups returned in the response.

      • Items (list) –

        A list of key groups.

        • (dict) –

          Contains information about a key group.

          • KeyGroup (dict) –

            A key group.

            • Id (string) –

              The identifier for the key group.

            • LastModifiedTime (datetime) –

              The date and time when the key group was last modified.

            • 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.

Exceptions

  • CloudFront.Client.exceptions.InvalidArgument