:doc:`MainframeModernization <../../m2>` / Paginator / ListDeployments

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



.. py:class:: MainframeModernization.Paginator.ListDeployments

  ::

    
    paginator = client.get_paginator('list_deployments')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListDeployments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          applicationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type applicationId: string
    :param applicationId: **[REQUIRED]** 

      The application 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**

      
      ::

        {
            'deployments': [
                {
                    'applicationId': 'string',
                    'applicationVersion': 123,
                    'creationTime': datetime(2015, 1, 1),
                    'deploymentId': 'string',
                    'environmentId': 'string',
                    'status': 'Deploying'|'Succeeded'|'Failed'|'Updating Deployment',
                    'statusReason': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The list of deployments that is returned.

          
          

          - *(dict) --* 

            A subset of information about a specific deployment.

            
            

            - **applicationId** *(string) --* 

              The unique identifier of the application.

              
            

            - **applicationVersion** *(integer) --* 

              The version of the application.

              
            

            - **creationTime** *(datetime) --* 

              The timestamp when the deployment was created.

              
            

            - **deploymentId** *(string) --* 

              The unique identifier of the deployment.

              
            

            - **environmentId** *(string) --* 

              The unique identifier of the runtime environment.

              
            

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

              The current status of the deployment.

              
            

            - **statusReason** *(string) --* 

              The reason for the reported status.

              
        
      
        

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

          A token to resume pagination.

          
    