Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

get-job

Description

Get a job for a branch, part of an Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-job
--app-id <value>
--branch-name <value>
--job-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an Amplify App.

--branch-name (string)

Name for the branch, for the Job.

--job-id (string)

Unique Id for the Job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

job -> (structure)

Structure for an execution job for an Amplify App.

summary -> (structure)

Summary for an execution job for an Amplify App.

jobArn -> (string)

Arn for the Job.

jobId -> (string)

Unique Id for the Job.

commitId -> (string)

Commit Id from 3rd party repository provider for the Job.

commitMessage -> (string)

Commit message from 3rd party repository provider for the Job.

commitTime -> (timestamp)

Commit date / time for the Job.

startTime -> (timestamp)

Start date / time for the Job.

status -> (string)

Status for the Job.

endTime -> (timestamp)

End date / time for the Job.

jobType -> (string)

Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.

steps -> (list)

Execution steps for an execution job, for an Amplify App.

(structure)

Structure for an execution step for an execution job, for an Amplify App.

stepName -> (string)

Name of the execution step.

startTime -> (timestamp)

Start date/ time of the execution step.

status -> (string)

Status of the execution step.

endTime -> (timestamp)

End date/ time of the execution step.

logUrl -> (string)

URL to the logs for the execution step.

artifactsUrl -> (string)

URL to the artifact for the execution step.

testArtifactsUrl -> (string)

URL to the test artifact for the execution step.

testConfigUrl -> (string)

URL to the test config for the execution step.

screenshots -> (map)

List of screenshot URLs for the execution step, if relevant.

key -> (string)

value -> (string)

statusReason -> (string)

The reason for current step status.

context -> (string)

The context for current step, will include build image if step is build.