AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

The request structure for the start job request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)

    The unique ID for an Amplify app.

#branch_nameString

The branch name for the job.

Returns:

  • (String)

    The branch name for the job.

#commit_idString

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

Returns:

  • (String)

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

#commit_messageString

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

Returns:

  • (String)

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

#commit_timeTime

The commit date and time for the job.

Returns:

  • (Time)

    The commit date and time for the job.

#job_idString

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

Returns:

  • (String)

    The unique ID for an existing job.

#job_reasonString

A descriptive reason for starting this job.

Returns:

  • (String)

    A descriptive reason for starting this job.

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

Possible values:

  • RELEASE
  • RETRY
  • MANUAL
  • WEB_HOOK

Returns:

  • (String)

    Describes the type for the job.