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

Class: Aws::S3Control::Types::UpdateJobStatusRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateJobStatusRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "AccountId", # required
  job_id: "JobId", # required
  requested_job_status: "Cancelled", # required, accepts Cancelled, Ready
  status_update_reason: "JobStatusUpdateReason",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

Returns:

  • (String)

#job_id ⇒ String

The ID of the job whose status you want to update.

Returns:

  • (String) —

    The ID of the job whose status you want to update.

#requested_job_status ⇒ String

The status that you want to move the specified job to.

Possible values:

  • Cancelled
  • Ready

Returns:

  • (String) —

    The status that you want to move the specified job to.

#status_update_reason ⇒ String

A description of the reason why you want to change the specified job\'s status. This field can be any string up to the maximum length.

Returns:

  • (String) —

    A description of the reason why you want to change the specified job\'s status.