:doc:`Outposts <../../outposts>` / Paginator / ListOutposts

************
ListOutposts
************



.. py:class:: Outposts.Paginator.ListOutposts

  ::

    
    paginator = client.get_paginator('list_outposts')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Outposts.Client.list_outposts`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListOutposts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          LifeCycleStatusFilter=[
              'string',
          ],
          AvailabilityZoneFilter=[
              'string',
          ],
          AvailabilityZoneIdFilter=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type LifeCycleStatusFilter: list
    :param LifeCycleStatusFilter: 

      Filters the results by the lifecycle status.

      

    
      - *(string) --* 

        The life cycle status.

        

      
  
    :type AvailabilityZoneFilter: list
    :param AvailabilityZoneFilter: 

      Filters the results by Availability Zone (for example, ``us-east-1a``).

      

    
      - *(string) --* 

        The Availability Zone.

        

      
  
    :type AvailabilityZoneIdFilter: list
    :param AvailabilityZoneIdFilter: 

      Filters the results by AZ ID (for example, ``use1-az1``).

      

    
      - *(string) --* 

        The ID of the Availability Zone.

        

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

      
      ::

        {
            'Outposts': [
                {
                    'OutpostId': 'string',
                    'OwnerId': 'string',
                    'OutpostArn': 'string',
                    'SiteId': 'string',
                    'Name': 'string',
                    'Description': 'string',
                    'LifeCycleStatus': 'string',
                    'AvailabilityZone': 'string',
                    'AvailabilityZoneId': 'string',
                    'Tags': {
                        'string': 'string'
                    },
                    'SiteArn': 'string',
                    'SupportedHardwareType': 'RACK'|'SERVER'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Outposts** *(list) --* 

          Information about the Outposts.

          
          

          - *(dict) --* 

            Information about an Outpost.

            
            

            - **OutpostId** *(string) --* 

              The ID of the Outpost.

              
            

            - **OwnerId** *(string) --* 

              The Amazon Web Services account ID of the Outpost owner.

              
            

            - **OutpostArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Outpost.

              
            

            - **SiteId** *(string) --* 

              The ID of the site.

              
            

            - **Name** *(string) --* 

              The name of the Outpost.

              
            

            - **Description** *(string) --* 

              The description of the Outpost.

              
            

            - **LifeCycleStatus** *(string) --* 

              The life cycle status.

              
            

            - **AvailabilityZone** *(string) --* 

              The Availability Zone.

              
            

            - **AvailabilityZoneId** *(string) --* 

              The ID of the Availability Zone.

              
            

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

              The Outpost tags.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **SiteArn** *(string) --* 

              The Amazon Resource Name (ARN) of the site.

              
            

            - **SupportedHardwareType** *(string) --* 

              The hardware type.

              
        
      
    