[ aws . s3control ]

update-job-status

Description

Updates the status for the specified job. Use this action 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 .

Related actions include:

• CreateJob

• ListJobs

• DescribeJob

• UpdateJobStatus

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-job-status
--account-id <value>
--job-id <value>
--requested-job-status <value>
[--status-update-reason <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

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

--job-id (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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To update the status of an Amazon S3 batch operations job

The following update-job-status example cancels the specified job which is awaiting approval.

aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \
    --requested-job-status Cancelled

Output:

{
    "Status": "Cancelled",
    "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386"
}

The following update-job-status example confirms and runs the specified which is awaiting approval.

aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \
    --requested-job-status Ready

Output::

{
    "Status": "Ready",
    "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca"
}

The following update-job-status example cancels the specified job which is running.

 aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \
    --requested-job-status Cancelled

Output::
{
         "Status": "Cancelling",
         "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca"
}

Output

JobId -> (string)

The ID for the job whose status was updated.

Status -> (string)

The current status for the specified job.

StatusUpdateReason -> (string)

The reason that the specified job’s status was updated.