:doc:`ApiGatewayV2 <../../apigatewayv2>` / Paginator / ListPortalProducts

******************
ListPortalProducts
******************



.. py:class:: ApiGatewayV2.Paginator.ListPortalProducts

  ::

    
    paginator = client.get_paginator('list_portal_products')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ApiGatewayV2.Client.list_portal_products`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/ListPortalProducts>`_    


    **Request Syntax**
    ::

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

      The resource owner of the portal product.

      

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

      
      ::

        {
            'Items': [
                {
                    'Description': 'string',
                    'DisplayName': 'string',
                    'LastModified': datetime(2015, 1, 1),
                    'PortalProductArn': 'string',
                    'PortalProductId': 'string',
                    'Tags': {
                        'string': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Success

        
        

        - **Items** *(list) --* 

          The elements from this collection.

          
          

          - *(dict) --* 

            Represents a portal product.

            
            

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

              The description.

              
            

            - **DisplayName** *(string) --* 

              The display name of a portal product.

              
            

            - **LastModified** *(datetime) --* 

              The timestamp when the portal product was last modified.

              
            

            - **PortalProductArn** *(string) --* 

              The ARN of a portal product.

              
            

            - **PortalProductId** *(string) --* 

              The portal product identifier.

              
            

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

              The collection of tags. Each tag element is associated with a given resource.

              
              

              - *(string) --* 
                

                - *(string) --* 

                  A string with a length between [0-1600].

                  
          
        
        
      
    