@aws-sdk/client-amplify

StartJobCommandInput Interface

The input for StartJobCommand.

Members

Name
Type
Details
appId Requiredstring | undefined

The unique ID for an Amplify app.

branchName Requiredstring | undefined

The name of the branch to use for the job.

jobType RequiredJobType | undefined

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

commitId string | undefined

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

commitMessage string | undefined

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

commitTime Date | undefined

The commit date and time for the job.

jobId string | undefined

The unique ID for an existing job. This is required if the value of jobType is RETRY.

jobReason string | undefined

A descriptive reason for starting the job.

Full Signature

export interface StartJobCommandInput extends StartJobRequest