:doc:`IVS <../../ivs>` / Paginator / ListChannels

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



.. py:class:: IVS.Paginator.ListChannels

  ::

    
    paginator = client.get_paginator('list_channels')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels>`_    


    **Request Syntax**
    ::

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

      Filters the channel list to match the specified name.

      

    
    :type filterByPlaybackRestrictionPolicyArn: string
    :param filterByPlaybackRestrictionPolicyArn: 

      Filters the channel list to match the specified policy.

      

    
    :type filterByRecordingConfigurationArn: string
    :param filterByRecordingConfigurationArn: 

      Filters the channel list to match the specified recording-configuration ARN.

      

    
    :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**

      
      ::

        {
            'channels': [
                {
                    'arn': 'string',
                    'authorized': True|False,
                    'insecureIngest': True|False,
                    'latencyMode': 'NORMAL'|'LOW',
                    'name': 'string',
                    'playbackRestrictionPolicyArn': 'string',
                    'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                    'recordingConfigurationArn': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **channels** *(list) --* 

          List of the matching channels.

          
          

          - *(dict) --* 

            Summary information about a channel.

            
            

            - **arn** *(string) --* 

              Channel ARN.

              
            

            - **authorized** *(boolean) --* 

              Whether the channel is private (enabled for playback authorization). Default: ``false``.

              
            

            - **insecureIngest** *(boolean) --* 

              Whether the channel allows insecure RTMP ingest. Default: ``false``.

              
            

            - **latencyMode** *(string) --* 

              Channel latency mode. Use ``NORMAL`` to broadcast and deliver live video up to Full HD. Use ``LOW`` for near-real-time interaction with viewers. Default: ``LOW``.

              
            

            - **name** *(string) --* 

              Channel name.

              
            

            - **playbackRestrictionPolicyArn** *(string) --* 

              Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

              
            

            - **preset** *(string) --* 

              Optional transcode preset for the channel. This is selectable only for ``ADVANCED_HD`` and ``ADVANCED_SD`` channel types. For those channel types, the default ``preset`` is ``HIGHER_BANDWIDTH_DELIVERY``. For other channel types ( ``BASIC`` and ``STANDARD``), ``preset`` is the empty string ( ``""``).

              
            

            - **recordingConfigurationArn** *(string) --* 

              Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

              
            

            - **tags** *(dict) --* 

              Tags attached to the resource. Array of 1-50 maps, each of the form ``string:string (key:value)``. See `Best practices and strategies <https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html>`__ in *Tagging Amazon Web Services Resources and Tag Editor* for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **type** *(string) --* 

              Channel type, which determines the allowable resolution and bitrate. *If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.* Default: ``STANDARD``. For details, see `Channel Types <https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html>`__.

              
        
      
        

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

          A token to resume pagination.

          
    