class Aws::Amplify::Types::StartJobRequest

The request structure for the start job request.

@note When making an API call, you may pass StartJobRequest

data as a hash:

    {
      app_id: "AppId", # required
      branch_name: "BranchName", # required
      job_id: "JobId",
      job_type: "RELEASE", # required, accepts RELEASE, RETRY, MANUAL, WEB_HOOK
      job_reason: "JobReason",
      commit_id: "CommitId",
      commit_message: "CommitMessage",
      commit_time: Time.now,
    }

@!attribute [rw] app_id

The unique ID for an Amplify app.
@return [String]

@!attribute [rw] branch_name

The branch name for the job.
@return [String]

@!attribute [rw] job_id

The unique ID for an existing job. This is required if the value of
`jobType` is `RETRY`.
@return [String]

@!attribute [rw] job_type

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.
@return [String]

@!attribute [rw] job_reason

A descriptive reason for starting this job.
@return [String]

@!attribute [rw] commit_id

The commit ID from a third-party repository provider for the job.
@return [String]

@!attribute [rw] commit_message

The commit message from a third-party repository provider for the
job.
@return [String]

@!attribute [rw] commit_time

The commit date and time for the job.
@return [Time]

@see docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJobRequest AWS API Documentation

Constants

SENSITIVE