ApiGatewayV2 / Client / list_portal_products

list_portal_products¶

ApiGatewayV2.Client.list_portal_products(**kwargs)¶

Lists portal products.

Request Syntax

response = client.list_portal_products(
    MaxResults='string',
    NextToken='string',
    ResourceOwner='string'
)

Parameters:

MaxResults (string) – The maximum number of elements to be returned for this resource.
NextToken (string) – The next page of elements from this collection. Not valid for the last element of the collection.
ResourceOwner (string) – The resource owner of the portal product.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Description': 'string',
            'DisplayName': 'string',
            'LastModified': datetime(2015, 1, 1),
            'PortalProductArn': 'string',
            'PortalProductId': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': '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].
- NextToken (string) –
  
  The next page of elements from this collection. Not valid for the last element of the collection.

Exceptions

ApiGatewayV2.Client.exceptions.TooManyRequestsException
ApiGatewayV2.Client.exceptions.BadRequestException
ApiGatewayV2.Client.exceptions.AccessDeniedException