APIGateway / Paginator / GetBasePathMappings

GetBasePathMappings

class APIGateway.Paginator.GetBasePathMappings

paginator = client.get_paginator('get_base_path_mappings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from APIGateway.Client.get_base_path_mappings().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainName (string) –

  [REQUIRED]

  The domain name of a BasePathMapping resource.

• domainNameId (string) – The identifier for the domain name resource. Supported only for private custom domain names.

• 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': [
        {
            'basePath': 'string',
            'restApiId': 'string',
            'stage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents a collection of BasePathMapping resources.

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      Represents the base path that callers of the API must provide as part of the URL after the domain name.

      • basePath (string) –

        The base path name that callers of the API must provide as part of the URL after the domain name.

      • restApiId (string) –

        The string identifier of the associated RestApi.

      • stage (string) –

        The name of the associated stage.

  • NextToken (string) –

    A token to resume pagination.