:doc:`LaunchWizard <../../launch-wizard>` / Client / list_deployments

****************
list_deployments
****************



.. py:method:: LaunchWizard.Client.list_deployments(**kwargs)

  

  Lists the deployments that have been created.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListDeployments>`_  


  **Request Syntax**
  ::

    response = client.list_deployments(
        filters=[
            {
                'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS',
                'values': [
                    'string',
                ]
            },
        ],
        maxResults=123,
        nextToken='string'
    )
    
  :type filters: list
  :param filters: 

    Filters to scope the results. The following filters are supported:

     

    
    * ``WORKLOAD_NAME`` - The name used in deployments.
     
    * ``DEPLOYMENT_STATUS`` - ``COMPLETED`` | ``CREATING`` | ``DELETE_IN_PROGRESS`` | ``DELETE_INITIATING`` | ``DELETE_FAILED`` | ``DELETED`` | ``FAILED`` | ``IN_PROGRESS`` | ``VALIDATING``
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.

      

    
      - **name** *(string) --* 

        The name of the filter. Filter names are case-sensitive.

        

      
      - **values** *(list) --* 

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

        

      
        - *(string) --* 

        
    
    

  :type maxResults: integer
  :param maxResults: 

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    

  
  :type nextToken: string
  :param nextToken: 

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    

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

    
    ::

      {
          'deployments': [
              {
                  'name': 'string',
                  'id': 'string',
                  'workloadName': 'string',
                  'patternName': 'string',
                  'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
                  'createdAt': datetime(2015, 1, 1),
                  'modifiedAt': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **deployments** *(list) --* 

        Lists the deployments.

        
        

        - *(dict) --* 

          A summary of the deployment data.

          
          

          - **name** *(string) --* 

            The name of the deployment

            
          

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

            The ID of the deployment.

            
          

          - **workloadName** *(string) --* 

            The name of the workload.

            
          

          - **patternName** *(string) --* 

            The name of the workload deployment pattern.

            
          

          - **status** *(string) --* 

            The status of the deployment.

            
          

          - **createdAt** *(datetime) --* 

            The time the deployment was created.

            
          

          - **modifiedAt** *(datetime) --* 

            The time the deployment was last modified.

            
      
    
      

      - **nextToken** *(string) --* 

        The token to include in another request to get the next page of items. This value is ``null`` when there are no more items to return.

        
  
  **Exceptions**
  
  *   :py:class:`LaunchWizard.Client.exceptions.InternalServerException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ValidationException`

  