ApiGatewayV2 / Paginator / ListPortalProducts

ListPortalProducts¶

class ApiGatewayV2.Paginator.ListPortalProducts ¶

paginator = client.get_paginator('list_portal_products')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.list_portal_products().

Request Syntax

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

Parameters:

ResourceOwner (string) – The resource owner of the portal product.
PaginationConfig (dict) –
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.

Return type:

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].