:doc:`APIGateway <../../apigateway>` / Client / get_deployments

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



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

  

  Gets information about a Deployments collection.

  

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


  **Request Syntax**
  ::

    response = client.get_deployments(
        restApiId='string',
        position='string',
        limit=123
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

  
  :type position: string
  :param position: 

    The current pagination position in the paged result set.

    

  
  :type limit: integer
  :param limit: 

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

    

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

    
    ::

      {
          'position': 'string',
          'items': [
              {
                  'id': 'string',
                  'description': 'string',
                  'createdDate': datetime(2015, 1, 1),
                  'apiSummary': {
                      'string': {
                          'string': {
                              'authorizationType': 'string',
                              'apiKeyRequired': True|False
                          }
                      }
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

      
      

      - **position** *(string) --* 
      

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

        The current page of elements from this collection.

        
        

        - *(dict) --* 

          An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

          
          

          - **id** *(string) --* 

            The identifier for the deployment resource.

            
          

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

            The description for the deployment resource.

            
          

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

            The date and time that the deployment resource was created.

            
          

          - **apiSummary** *(dict) --* 

            A summary of the RestApi at the date and time that the deployment resource was created.

            
            

            - *(string) --* 
              

              - *(dict) --* 
                

                - *(string) --* 
                  

                  - *(dict) --* 

                    Represents a summary of a Method resource, given a particular date and time.

                    
                    

                    - **authorizationType** *(string) --* 

                      The method's authorization type. Valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, ``CUSTOM`` for using a custom authorizer, or ``COGNITO_USER_POOLS`` for using a Cognito user pool.

                      
                    

                    - **apiKeyRequired** *(boolean) --* 

                      Specifies whether the method requires a valid ApiKey.

                      
                
            
          
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

  
  *   :py:class:`APIGateway.Client.exceptions.NotFoundException`

  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

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

  
  *   :py:class:`APIGateway.Client.exceptions.ServiceUnavailableException`

  