:doc:`MediaConnect <../../mediaconnect>` / Paginator / ListGatewayInstances

********************
ListGatewayInstances
********************



.. py:class:: MediaConnect.Paginator.ListGatewayInstances

  ::

    
    paginator = client.get_paginator('list_gateway_instances')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MediaConnect.Client.list_gateway_instances`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListGatewayInstances>`_    


    **Request Syntax**
    ::

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

      Filter the list results to display only the instances associated with the selected Gateway 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**

      
      ::

        {
            'Instances': [
                {
                    'GatewayArn': 'string',
                    'GatewayInstanceArn': 'string',
                    'InstanceId': 'string',
                    'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Instances** *(list) --* 

          A list of instance summaries.

          
          

          - *(dict) --* 

            A summary of an instance.

            
            

            - **GatewayArn** *(string) --* 

              The Amazon Resource Name (ARN) of the gateway.

              
            

            - **GatewayInstanceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the instance.

              
            

            - **InstanceId** *(string) --* 

              The managed instance ID generated by the SSM install. This will begin with "mi-".

              
            

            - **InstanceState** *(string) --* 

              The status of the instance.

              
        
      
    