update_classification_job

Macie2.Client.update_classification_job(**kwargs)

Changes the status of a classification job.

See also: AWS API Documentation

Request Syntax

response = client.update_classification_job(
    jobId='string',
    jobStatus='RUNNING'|'PAUSED'|'CANCELLED'|'COMPLETE'|'IDLE'|'USER_PAUSED'
)
Parameters
  • jobId (string) --

    [REQUIRED]

    The unique identifier for the classification job.

  • jobStatus (string) --

    [REQUIRED]

    The new status for the job. Valid values are:

    • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED. If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
    • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED. If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
    • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job. If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The request succeeded. The job's status was changed and there isn't any content to include in the body of the response (No Content).

Exceptions

  • Macie2.Client.exceptions.ValidationException
  • Macie2.Client.exceptions.InternalServerException
  • Macie2.Client.exceptions.ServiceQuotaExceededException
  • Macie2.Client.exceptions.AccessDeniedException
  • Macie2.Client.exceptions.ResourceNotFoundException
  • Macie2.Client.exceptions.ThrottlingException
  • Macie2.Client.exceptions.ConflictException