mediapackagev2 / Paginator / ListChannels

ListChannels#

class mediapackagev2.Paginator.ListChannels#

paginator = client.get_paginator('list_channels')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

ChannelGroupName (string) –
[REQUIRED]

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.
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': [
        {
            'Arn': 'string',
            'ChannelName': 'string',
            'ChannelGroupName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'InputType': 'HLS'|'CMAF'
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  The objects being returned.
  - (dict) –
    
    The configuration of the channel.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) associated with the resource.
    - ChannelName (string) –
      
      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and 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.
    - CreatedAt (datetime) –
      
      The date and time the channel was created.
    - ModifiedAt (datetime) –
      
      The date and time the channel was modified.
    - Description (string) –
      
      Any descriptive information that you want to add to the channel for future identification purposes.
    - InputType (string) –
      
      The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
      
      The allowed values are:
      - HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
      - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).