You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Request structure for Start job request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#branch_nameString

Name for the branch, for the Job.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#commit_idString

Commit Id from 3rd party repository provider for the Job.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#commit_messageString

Commit message from 3rd party repository provider for the Job.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#commit_timeTime

Commit date / time for the Job.

Returns:

  • (Time)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#job_idString

Unique Id for an existing job. Required for "RETRY" JobType.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#job_reasonString

Descriptive reason for starting this job.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end

#job_typeString

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1777

class StartJobRequest < Struct.new(
  :app_id,
  :branch_name,
  :job_id,
  :job_type,
  :job_reason,
  :commit_id,
  :commit_message,
  :commit_time)
  include Aws::Structure
end