APIGateway / Paginator / GetModels

GetModels

class APIGateway.Paginator.GetModels

paginator = client.get_paginator('get_models')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• restApiId (string) –

  [REQUIRED]

  The string identifier of the associated RestApi.

• 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': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'schema': 'string',
            'contentType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents a collection of Model resources.

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      Represents the data structure of a method’s request or response payload.

      • id (string) –

        The identifier for the model resource.

      • name (string) –

        The name of the model. Must be an alphanumeric string.

      • description (string) –

        The description of the model.

      • schema (string) –

        The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include “*/” characters in the description of any properties because such “*/” characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API’s SDK generated by API Gateway to fail.

      • contentType (string) –

        The content-type for the model.

  • NextToken (string) –

    A token to resume pagination.