S3Control / Client / update_job_status

update_job_status#

S3Control.Client.update_job_status(**kwargs)#

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:

See also: AWS API Documentation

Request Syntax

response = client.update_job_status(
    AccountId='string',
    JobId='string',
    RequestedJobStatus='Cancelled'|'Ready',
    StatusUpdateReason='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • JobId (string) –

    [REQUIRED]

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

  • RequestedJobStatus (string) –

    [REQUIRED]

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

  • StatusUpdateReason (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.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'Status': 'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
    'StatusUpdateReason': 'string'
}

Response Structure

  • (dict) –

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

Exceptions

  • S3Control.Client.exceptions.BadRequestException

  • S3Control.Client.exceptions.TooManyRequestsException

  • S3Control.Client.exceptions.NotFoundException

  • S3Control.Client.exceptions.JobStatusException

  • S3Control.Client.exceptions.InternalServiceException