[ aws . amplify ]

get-job

Description

Returns a job for a branch 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique ID for an Amplify app.

--branch-name (string)

The branch name for the job.

--job-id (string)

The unique ID for the job.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

job -> (structure)

Describes an execution job for an Amplify app.

summary -> (structure)

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 -> (timestamp)

The commit date and time for the job.

startTime -> (timestamp)

The start date and time for the job.

status -> (string)

The current status for the job.

endTime -> (timestamp)

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. 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.

steps -> (list)

The execution steps for an execution job, for an Amplify app.

(structure)

Describes an execution step, for an execution job, for an Amplify app.

stepName -> (string)

The name of the execution step.

startTime -> (timestamp)

The start date and time of the execution step.

status -> (string)

The status of the execution step.

endTime -> (timestamp)

The end date and time of the execution step.

logUrl -> (string)

The URL to the logs for the execution step.

artifactsUrl -> (string)

The URL to the artifact for the execution step.

testArtifactsUrl -> (string)

The URL to the test artifact for the execution step.

testConfigUrl -> (string)

The URL to the test configuration for the execution step.

screenshots -> (map)

The list of screenshot URLs for the execution step, if relevant.

key -> (string)

value -> (string)

statusReason -> (string)

The reason for the current step status.

context -> (string)

The context for the current step. Includes a build image if the step is build.