:doc:`ApiGatewayV2 <../../apigatewayv2>` / Paginator / GetModels

*********
GetModels
*********



.. py:class:: ApiGatewayV2.Paginator.GetModels

  ::

    
    paginator = client.get_paginator('get_models')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ApiGatewayV2.Client.get_models`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/GetModels>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ApiId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ApiId: string
    :param ApiId: **[REQUIRED]** 

      The API identifier.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Items': [
                {
                    'ContentType': 'string',
                    'Description': 'string',
                    'ModelId': 'string',
                    'Name': 'string',
                    'Schema': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Success

        
        

        - **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 <https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html>`__.

            
            

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

              
        
      
    