:doc:`Amplify <../../amplify>` / Paginator / ListJobs

********
ListJobs
********



.. py:class:: Amplify.Paginator.ListJobs

  ::

    
    paginator = client.get_paginator('list_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Amplify.Client.list_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs>`_    


    **Request Syntax**
    ::

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

      The unique ID for an Amplify app.

      

    
    :type branchName: string
    :param branchName: **[REQUIRED]** 

      The name of the branch to use for the request.

      

    
    :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**

      
      ::

        {
            'jobSummaries': [
                {
                    'jobArn': 'string',
                    'jobId': 'string',
                    'commitId': 'string',
                    'commitMessage': 'string',
                    'commitTime': datetime(2015, 1, 1),
                    'startTime': datetime(2015, 1, 1),
                    'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
                    'endTime': datetime(2015, 1, 1),
                    'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
                    'sourceUrl': 'string',
                    'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        The maximum number of records to list in a single response.

        
        

        - **jobSummaries** *(list) --* 

          The result structure for the list job result request.

          
          

          - *(dict) --* 

            Describes the summary for an execution job for an Amplify app.

            
            

            - **jobArn** *(string) --* 

              The Amazon Resource Name (ARN) for the job.

              
            

            - **jobId** *(string) --* 

              The unique ID for the job.

              
            

            - **commitId** *(string) --* 

              The commit ID from a third-party repository provider for the job.

              
            

            - **commitMessage** *(string) --* 

              The commit message from a third-party repository provider for the job.

              
            

            - **commitTime** *(datetime) --* 

              The commit date and time for the job.

              
            

            - **startTime** *(datetime) --* 

              The start date and time for the job.

              
            

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

              The current status for the job.

              
            

            - **endTime** *(datetime) --* 

              The end date and time for the job.

              
            

            - **jobType** *(string) --* 

              The type for the job. If the value is ``RELEASE``, the job was manually released from its source by using the ``StartJob`` API. This value is available only for apps that are connected to a repository.

               

              If the value is ``RETRY``, the job was manually retried using the ``StartJob`` API. If the value is ``WEB_HOOK``, the job was automatically triggered by webhooks. If the value is ``MANUAL``, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

              
            

            - **sourceUrl** *(string) --* 

              The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

              
            

            - **sourceUrlType** *(string) --* 

              The type of source specified by the ``sourceURL``. If the value is ``ZIP``, the source is a .zip file. If the value is ``BUCKET_PREFIX``, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ``ZIP``.

              
        
      
        

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

          A token to resume pagination.

          
    