:doc:`APIGateway <../../apigateway>` / Paginator / GetDocumentationVersions

************************
GetDocumentationVersions
************************



.. py:class:: APIGateway.Paginator.GetDocumentationVersions

  ::

    
    paginator = client.get_paginator('get_documentation_versions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`APIGateway.Client.get_documentation_versions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetDocumentationVersions>`_    


    **Request Syntax**
    ::

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

      The string identifier of the associated RestApi.

      

    
    :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': [
                {
                    'version': 'string',
                    'createdDate': datetime(2015, 1, 1),
                    'description': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        The collection of documentation snapshots of an API.

        
        

        - **items** *(list) --* 

          The current page of elements from this collection.

          
          

          - *(dict) --* 

            A snapshot of the documentation of an API.

            
            

            - **version** *(string) --* 

              The version identifier of the API documentation snapshot.

              
            

            - **createdDate** *(datetime) --* 

              The date when the API documentation snapshot is created.

              
            

            - **description** *(string) --* 

              The description of the API documentation snapshot.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    