ApiGatewayV2 / Paginator / GetModels


class ApiGatewayV2.Paginator.GetModels#
paginator = client.get_paginator('get_models')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ApiId (string) –


    The API identifier.

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



Response Syntax

    'Items': [
            'ContentType': 'string',
            'Description': 'string',
            'ModelId': 'string',
            'Name': 'string',
            'Schema': 'string'


Response Structure

  • (dict) –


    • Items (list) –

      The elements from this collection.

      • (dict) –

        Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

        • ContentType (string) –

          The content-type for the model, for example, “application/json”.

        • Description (string) –

          The description of the model.

        • ModelId (string) –

          The model identifier.

        • Name (string) –

          The name of the model. Must be alphanumeric.

        • Schema (string) –

          The schema for the model. For application/json models, this should be JSON schema draft 4 model.