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

**************
GetDeployments
**************



.. py:class:: ApiGatewayV2.Paginator.GetDeployments

  ::

    
    paginator = client.get_paginator('get_deployments')

  
  

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

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

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


    **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': [
                {
                    'AutoDeployed': True|False,
                    'CreatedDate': datetime(2015, 1, 1),
                    'DeploymentId': 'string',
                    'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
                    'DeploymentStatusMessage': 'string',
                    'Description': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Success

        
        

        - **Items** *(list) --* 

          The elements from this collection.

          
          

          - *(dict) --* 

            An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

            
            

            - **AutoDeployed** *(boolean) --* 

              Specifies whether a deployment was automatically released.

              
            

            - **CreatedDate** *(datetime) --* 

              The date and time when the Deployment resource was created.

              
            

            - **DeploymentId** *(string) --* 

              The identifier for the deployment.

              
            

            - **DeploymentStatus** *(string) --* 

              The status of the deployment: PENDING, FAILED, or SUCCEEDED.

              
            

            - **DeploymentStatusMessage** *(string) --* 

              May contain additional feedback on the status of an API deployment.

              
            

            - **Description** *(string) --* 

              The description for the deployment.

              
        
      
    