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
show all
Defined in:
(unknown)

Overview

Note:

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

Request structure for Start job request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)

    Unique Id for an Amplify App.

#branch_nameString

Name for the branch, for the Job.

Returns:

  • (String)

    Name for the branch, for the Job.

#commit_idString

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

Returns:

  • (String)

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

#commit_messageString

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

Returns:

  • (String)

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

#commit_timeTime

Commit date / time for the Job.

Returns:

  • (Time)

    Commit date / time for the Job.

#job_idString

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

Returns:

  • (String)

    Unique Id for an existing job.

#job_reasonString

Descriptive reason for starting this job.

Returns:

  • (String)

    Descriptive reason for starting this job.

#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.

Possible values:

  • RELEASE
  • RETRY
  • MANUAL
  • WEB_HOOK

Returns:

  • (String)

    Type for the Job.