Amplify / Client / list_jobs

list_jobs#

Amplify.Client.list_jobs(**kwargs)#

Lists the jobs for a branch of an Amplify app.

Request Syntax

response = client.list_jobs(
    appId='string',
    branchName='string',
    nextToken='string',
    maxResults=123
)

Parameters:

appId (string) –
[REQUIRED]

The unique ID for an Amplify app.
branchName (string) –
[REQUIRED]

The name of the branch to use for the request.
nextToken (string) – A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
maxResults (integer) – The maximum number of records to list in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'commitId': 'string',
            'commitMessage': 'string',
            'commitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': '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 pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Exceptions

Amplify.Client.exceptions.BadRequestException
Amplify.Client.exceptions.UnauthorizedException
Amplify.Client.exceptions.InternalFailureException
Amplify.Client.exceptions.LimitExceededException