:doc:`LaunchWizard <../../launch-wizard>` / Paginator / ListDeployments

***************
ListDeployments
***************



.. py:class:: LaunchWizard.Paginator.ListDeployments

  ::

    
    paginator = client.get_paginator('list_deployments')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`LaunchWizard.Client.list_deployments`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS',
                  'values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 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**

      
      ::

        {
            '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) --* 

          A token to resume pagination.

          
    