CloudFront / Paginator / ListConnectionGroups

ListConnectionGroups¶

class CloudFront.Paginator.ListConnectionGroups¶

paginator = client.get_paginator('list_connection_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudFront.Client.list_connection_groups().

Request Syntax

response_iterator = paginator.paginate(
    AssociationFilter={
        'AnycastIpListId': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

AssociationFilter (dict) –
Filter by associated Anycast IP list ID.
- AnycastIpListId (string) –
  
  The ID of the Anycast static IP list.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionGroups': [
        {
            'Id': 'string',
            'Name': 'string',
            'Arn': 'string',
            'RoutingEndpoint': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ETag': 'string',
            'AnycastIpListId': 'string',
            'Enabled': True|False,
            'Status': 'string',
            'IsDefault': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ConnectionGroups (list) –
  
  The list of connection groups that you retrieved.
  - (dict) –
    
    A summary that contains details about your connection groups.
    - Id (string) –
      
      The ID of the connection group.
    - Name (string) –
      
      The name of the connection group.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the connection group.
    - RoutingEndpoint (string) –
      
      The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
    - CreatedTime (datetime) –
      
      The date and time when the connection group was created.
    - LastModifiedTime (datetime) –
      
      The date and time when the connection group was updated.
    - ETag (string) –
      
      The current version of the connection group.
    - AnycastIpListId (string) –
      
      The ID of the Anycast static IP list.
    - Enabled (boolean) –
      
      Whether the connection group is enabled
    - Status (string) –
      
      The status of the connection group.
    - IsDefault (boolean) –
      
      Whether the connection group is the default connection group for the distribution tenants.
- NextToken (string) –
  
  A token to resume pagination.