mediapackagev2 / Paginator / ListChannelGroups

ListChannelGroups¶

class mediapackagev2.Paginator.ListChannelGroups¶

paginator = client.get_paginator('list_channel_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from mediapackagev2.Client.list_channel_groups().

Request Syntax

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

Parameters:

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

{
    'Items': [
        {
            'ChannelGroupName': 'string',
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  The objects being returned.
  - (dict) –
    
    The configuration of the channel group.
    - ChannelGroupName (string) –
      
      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) associated with the resource.
    - CreatedAt (datetime) –
      
      The date and time the channel group was created.
    - ModifiedAt (datetime) –
      
      The date and time the channel group was modified.
    - Description (string) –
      
      Any descriptive information that you want to add to the channel group for future identification purposes.