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

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

Overview

Note:

When making an API call, you may pass UpdateJobStatusRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Web Services account ID associated with the S3 Batch Operations job.

Returns:

  • (String)


6375
6376
6377
6378
6379
6380
6381
6382
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6375

class UpdateJobStatusRequest < Struct.new(
  :account_id,
  :job_id,
  :requested_job_status,
  :status_update_reason)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


6375
6376
6377
6378
6379
6380
6381
6382
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6375

class UpdateJobStatusRequest < Struct.new(
  :account_id,
  :job_id,
  :requested_job_status,
  :status_update_reason)
  SENSITIVE = []
  include Aws::Structure
end

#requested_job_statusString

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

Returns:

  • (String)


6375
6376
6377
6378
6379
6380
6381
6382
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6375

class UpdateJobStatusRequest < Struct.new(
  :account_id,
  :job_id,
  :requested_job_status,
  :status_update_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_update_reasonString

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)


6375
6376
6377
6378
6379
6380
6381
6382
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6375

class UpdateJobStatusRequest < Struct.new(
  :account_id,
  :job_id,
  :requested_job_status,
  :status_update_reason)
  SENSITIVE = []
  include Aws::Structure
end