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

****************
ListCatalogItems
****************



.. py:class:: Outposts.Paginator.ListCatalogItems

  ::

    
    paginator = client.get_paginator('list_catalog_items')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ItemClassFilter=[
              'RACK'|'SERVER',
          ],
          SupportedStorageFilter=[
              'EBS'|'S3',
          ],
          EC2FamilyFilter=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ItemClassFilter: list
    :param ItemClassFilter: 

      Filters the results by item class.

      

    
      - *(string) --* 

      
  
    :type SupportedStorageFilter: list
    :param SupportedStorageFilter: 

      Filters the results by storage option.

      

    
      - *(string) --* 

      
  
    :type EC2FamilyFilter: list
    :param EC2FamilyFilter: 

      Filters the results by EC2 family (for example, M5).

      

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

      
      ::

        {
            'CatalogItems': [
                {
                    'CatalogItemId': 'string',
                    'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
                    'EC2Capacities': [
                        {
                            'Family': 'string',
                            'MaxSize': 'string',
                            'Quantity': 'string'
                        },
                    ],
                    'PowerKva': ...,
                    'WeightLbs': 123,
                    'SupportedUplinkGbps': [
                        123,
                    ],
                    'SupportedStorage': [
                        'EBS'|'S3',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CatalogItems** *(list) --* 

          Information about the catalog items.

          
          

          - *(dict) --* 

            Information about a catalog item.

            
            

            - **CatalogItemId** *(string) --* 

              The ID of the catalog item.

              
            

            - **ItemStatus** *(string) --* 

              The status of a catalog item.

              
            

            - **EC2Capacities** *(list) --* 

              Information about the EC2 capacity of an item.

              
              

              - *(dict) --* 

                Information about EC2 capacity.

                
                

                - **Family** *(string) --* 

                  The family of the EC2 capacity.

                  
                

                - **MaxSize** *(string) --* 

                  The maximum size of the EC2 capacity.

                  
                

                - **Quantity** *(string) --* 

                  The quantity of the EC2 capacity.

                  
            
          
            

            - **PowerKva** *(float) --* 

              Information about the power draw of an item.

              
            

            - **WeightLbs** *(integer) --* 

              The weight of the item in pounds.

              
            

            - **SupportedUplinkGbps** *(list) --* 

              The uplink speed this catalog item requires for the connection to the Region.

              
              

              - *(integer) --* 
          
            

            - **SupportedStorage** *(list) --* 

              The supported storage options for the catalog item.

              
              

              - *(string) --* 
          
        
      
    