You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Amplify::Types::StartJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Amplify::Types::StartJobRequest
- Defined in:
- (unknown)
Overview
When passing StartJobRequest as input to an Aws::Client method, you can use a vanilla 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,
}
The request structure for the start job request.
Instance Attribute Summary collapse
-
#app_id ⇒ String
The unique ID for an Amplify app.
-
#branch_name ⇒ String
The branch name for the job.
-
#commit_id ⇒ String
The commit ID from a third-party repository provider for the job.
-
#commit_message ⇒ String
The commit message from a third-party repository provider for the job.
-
#commit_time ⇒ Time
The commit date and time for the job.
-
#job_id ⇒ String
The unique ID for an existing job.
-
#job_reason ⇒ String
A descriptive reason for starting this job.
-
#job_type ⇒ String
Describes the type for the job.
Instance Attribute Details
#app_id ⇒ String
The unique ID for an Amplify app.
#branch_name ⇒ String
The branch name for the job.
#commit_id ⇒ String
The commit ID from a third-party repository provider for the job.
#commit_message ⇒ String
The commit message from a third-party repository provider for the job.
#commit_time ⇒ Time
The commit date and time for the job.
#job_id ⇒ String
The unique ID for an existing job. This is required if the value of
jobType
is RETRY
.
#job_reason ⇒ String
A descriptive reason for starting this job.
#job_type ⇒ String
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.
Possible values:
- RELEASE
- RETRY
- MANUAL
- WEB_HOOK