:doc:`ApiGatewayV2 <../../apigatewayv2>` / Client / get_deployments

***************
get_deployments
***************



.. py:method:: ApiGatewayV2.Client.get_deployments(**kwargs)

  

  Gets the Deployments for an API.

  

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


  **Request Syntax**
  ::

    response = client.get_deployments(
        ApiId='string',
        MaxResults='string',
        NextToken='string'
    )
    
  :type ApiId: string
  :param ApiId: **[REQUIRED]** 

    The API identifier.

    

  
  :type MaxResults: string
  :param MaxResults: 

    The maximum number of elements to be returned for this resource.

    

  
  :type NextToken: string
  :param NextToken: 

    The next page of elements from this collection. Not valid for the last element of the collection.

    

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

    
    ::

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

            
      
    
      

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

        The next page of elements from this collection. Not valid for the last element of the collection.

        
  
  **Exceptions**
  
  *   :py:class:`ApiGatewayV2.Client.exceptions.NotFoundException`

  
  *   :py:class:`ApiGatewayV2.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`ApiGatewayV2.Client.exceptions.BadRequestException`

  