:doc:`MediaTailor <../../mediatailor>` / Client / list_channels

*************
list_channels
*************



.. py:method:: MediaTailor.Client.list_channels(**kwargs)

  

  Retrieves information about the channels that are associated with the current AWS account.

  

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


  **Request Syntax**
  ::

    response = client.list_channels(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than ``MaxResults`` channels, use the value of ``NextToken`` in the response to get the next page of results.

     

    The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than ``MaxResults`` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the ``NextToken`` value from each response until the response no longer includes a ``NextToken`` value.

    

  
  :type NextToken: string
  :param NextToken: 

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

     

    For the first ``ListChannels`` request, omit this value. For subsequent requests, get the value of ``NextToken`` from the previous response and specify that value for ``NextToken`` in the request. Continue making requests until the response no longer includes a ``NextToken`` value, which indicates that all results have been retrieved.

    

  
  
  :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',
                  ]
              },
          ],
          'NextToken': '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) --* 
        
      
    
      

      - **NextToken** *(string) --* 

        Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

        
  