:doc:`MediaTailor <../../mediatailor>` / Paginator / ListChannels

************
ListChannels
************



.. py:class:: MediaTailor.Paginator.ListChannels

  ::

    
    paginator = client.get_paginator('list_channels')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MediaTailor.Client.list_channels`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannels>`_    


    **Request Syntax**
    ::

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

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Items': [
                {
                    'Arn': 'string',
                    'ChannelName': 'string',
                    'ChannelState': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'FillerSlate': {
                        'SourceLocationName': 'string',
                        'VodSourceName': 'string'
                    },
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'Outputs': [
                        {
                            'DashPlaylistSettings': {
                                'ManifestWindowSeconds': 123,
                                'MinBufferTimeSeconds': 123,
                                'MinUpdatePeriodSeconds': 123,
                                'SuggestedPresentationDelaySeconds': 123
                            },
                            'HlsPlaylistSettings': {
                                'ManifestWindowSeconds': 123,
                                'AdMarkupType': [
                                    'DATERANGE'|'SCTE35_ENHANCED',
                                ]
                            },
                            'ManifestName': 'string',
                            'PlaybackUrl': 'string',
                            'SourceGroup': 'string'
                        },
                    ],
                    'PlaybackMode': 'string',
                    'Tags': {
                        'string': 'string'
                    },
                    'Tier': 'string',
                    'LogConfiguration': {
                        'LogTypes': [
                            'AS_RUN',
                        ]
                    },
                    'Audiences': [
                        'string',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          A list of channels that are associated with this account.

          
          

          - *(dict) --* 

            The configuration parameters for a channel. For information about MediaTailor channels, see `Working with channels <https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html>`__ in the *MediaTailor User Guide*.

            
            

            - **Arn** *(string) --* 

              The ARN of the channel.

              
            

            - **ChannelName** *(string) --* 

              The name of the channel.

              
            

            - **ChannelState** *(string) --* 

              Returns the state whether the channel is running or not.

              
            

            - **CreationTime** *(datetime) --* 

              The timestamp of when the channel was created.

              
            

            - **FillerSlate** *(dict) --* 

              The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the ``LINEAR`` ``PlaybackMode``. MediaTailor doesn't support filler slate for channels using the ``LOOP`` ``PlaybackMode``.

              
              

              - **SourceLocationName** *(string) --* 

                The name of the source location where the slate VOD source is stored.

                
              

              - **VodSourceName** *(string) --* 

                The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

                
          
            

            - **LastModifiedTime** *(datetime) --* 

              The timestamp of when the channel was last modified.

              
            

            - **Outputs** *(list) --* 

              The channel's output properties.

              
              

              - *(dict) --* 

                The output item response.

                
                

                - **DashPlaylistSettings** *(dict) --* 

                  DASH manifest configuration settings.

                  
                  

                  - **ManifestWindowSeconds** *(integer) --* 

                    The total duration (in seconds) of each manifest. Minimum value: ``30`` seconds. Maximum value: ``3600`` seconds.

                    
                  

                  - **MinBufferTimeSeconds** *(integer) --* 

                    Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: ``2`` seconds. Maximum value: ``60`` seconds.

                    
                  

                  - **MinUpdatePeriodSeconds** *(integer) --* 

                    Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: ``2`` seconds. Maximum value: ``60`` seconds.

                    
                  

                  - **SuggestedPresentationDelaySeconds** *(integer) --* 

                    Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: ``2`` seconds. Maximum value: ``60`` seconds.

                    
              
                

                - **HlsPlaylistSettings** *(dict) --* 

                  HLS manifest configuration settings.

                  
                  

                  - **ManifestWindowSeconds** *(integer) --* 

                    The total duration (in seconds) of each manifest. Minimum value: ``30`` seconds. Maximum value: ``3600`` seconds.

                    
                  

                  - **AdMarkupType** *(list) --* 

                    Determines the type of SCTE 35 tags to use in ad markup. Specify ``DATERANGE`` to use ``DATERANGE`` tags (for live or VOD content). Specify ``SCTE35_ENHANCED`` to use ``EXT-X-CUE-OUT`` and ``EXT-X-CUE-IN`` tags (for VOD content only).

                    
                    

                    - *(string) --* 
                
              
                

                - **ManifestName** *(string) --* 

                  The name of the manifest for the channel that will appear in the channel output's playback URL.

                  
                

                - **PlaybackUrl** *(string) --* 

                  The URL used for playback by content players.

                  
                

                - **SourceGroup** *(string) --* 

                  A string used to associate a package configuration source group with a channel output.

                  
            
          
            

            - **PlaybackMode** *(string) --* 

              The type of playback mode for this channel.

               

              ``LINEAR`` - Programs play back-to-back only once.

               

              ``LOOP`` - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

              
            

            - **Tags** *(dict) --* 

              The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see `Tagging AWS Elemental MediaTailor Resources <https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html>`__.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **Tier** *(string) --* 

              The tier for this channel. STANDARD tier channels can contain live programs.

              
            

            - **LogConfiguration** *(dict) --* 

              The log configuration.

              
              

              - **LogTypes** *(list) --* 

                The log types.

                
                

                - *(string) --* 
            
          
            

            - **Audiences** *(list) --* 

              The list of audiences defined in channel.

              
              

              - *(string) --* 
          
        
      
    