Class: Aws::Amplify::Types::StartJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Amplify::Types::StartJobRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-amplify/types.rb
Overview
The request structure for the start job request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#app_id ⇒ String
The unique ID for an Amplify app.
-
#branch_name ⇒ String
The name of the branch to use 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 the job.
-
#job_type ⇒ String
Describes the type for the job.
Instance Attribute Details
#app_id ⇒ String
The unique ID for an Amplify app.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#branch_name ⇒ String
The name of the branch to use for the job.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#commit_id ⇒ String
The commit ID from a third-party repository provider for the job.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#commit_message ⇒ String
The commit message from a third-party repository provider for the job.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#commit_time ⇒ Time
The commit date and time for the job.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The unique ID for an existing job. This is required if the value of ‘jobType` is `RETRY`.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#job_reason ⇒ String
A descriptive reason for starting the job.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |
#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.
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 |
# File 'lib/aws-sdk-amplify/types.rb', line 2406 class StartJobRequest < Struct.new( :app_id, :branch_name, :job_id, :job_type, :job_reason, :commit_id, :commit_message, :commit_time) SENSITIVE = [] include Aws::Structure end |