:doc:`GameLift <../../gamelift>` / Paginator / DescribeGameServerInstances

***************************
DescribeGameServerInstances
***************************



.. py:class:: GameLift.Paginator.DescribeGameServerInstances

  ::

    
    paginator = client.get_paginator('describe_game_server_instances')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GameLift.Client.describe_game_server_instances`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerInstances>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          GameServerGroupName='string',
          InstanceIds=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GameServerGroupName: string
    :param GameServerGroupName: **[REQUIRED]** 

      A unique identifier for the game server group. Use either the name or ARN value.

      

    
    :type InstanceIds: list
    :param InstanceIds: 

      The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: ``i-1234567890abcdef0``. To retrieve all instances in the game server group, leave this parameter empty.

      

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

      
      ::

        {
            'GameServerInstances': [
                {
                    'GameServerGroupName': 'string',
                    'GameServerGroupArn': 'string',
                    'InstanceId': 'string',
                    'InstanceStatus': 'ACTIVE'|'DRAINING'|'SPOT_TERMINATING'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **GameServerInstances** *(list) --* 

          The collection of requested game server instances.

          
          

          - *(dict) --* 

            Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see ``DescribeGameServerGroup`` and with the EC2 launch template that was used when creating the game server group.

             

            Retrieve game server instances for a game server group by calling ``DescribeGameServerInstances``.

            
            

            - **GameServerGroupName** *(string) --* 

              A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

              
            

            - **GameServerGroupArn** *(string) --* 

              A generated unique identifier for the game server group that includes the game server instance.

              
            

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

              The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: ``i-1234567890abcdef0``.

              
            

            - **InstanceStatus** *(string) --* 

              Current status of the game server instance

              
        
      
    