Skip to content

Update Job Status

s3control_update_job_status R Documentation

Updates the status for the specified job

Description

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Permissions

To use the update_job_status operation, you must have permission to perform the s3:UpdateJobStatus action.

Related actions include:

  • create_job

  • list_jobs

  • describe_job

  • update_job_status

Usage

s3control_update_job_status(AccountId, JobId, RequestedJobStatus,
  StatusUpdateReason)

Arguments

AccountId

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

JobId

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

RequestedJobStatus

[required] The status that you want to move the specified job to.

StatusUpdateReason

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.

Value

A list with the following syntax: 

list(
  JobId = "string",
  Status = "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended",
  StatusUpdateReason = "string"
)

Request syntax

svc$update_job_status(
  AccountId = "string",
  JobId = "string",
  RequestedJobStatus = "Cancelled"|"Ready",
  StatusUpdateReason = "string"
)