Class: Aws::Amplify::Types::StartJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

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,
}

The request structure for the start job request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_nameString

The branch name for the job.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_idString

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

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_messageString

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

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_timeTime

The commit date and time for the job.

Returns:

  • (Time)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_idString

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

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_reasonString

A descriptive reason for starting this job.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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_typeString

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.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2442

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