Struct aws_sdk_macie2::client::fluent_builders::UpdateClassificationJob

pub struct UpdateClassificationJob { /* private fields */ }

Fluent builder constructing a request to UpdateClassificationJob.

Changes the status of a classification job.

Implementations

impl UpdateClassificationJob

pub async fn send(
    self
) -> Result<UpdateClassificationJobOutput, SdkError<UpdateClassificationJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn job_id(self, input: impl Into<String>) -> Self

The unique identifier for the classification job.

pub fn set_job_id(self, input: Option<String>) -> Self

The unique identifier for the classification job.

pub fn job_status(self, input: JobStatus) -> Self

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.

pub fn set_job_status(self, input: Option<JobStatus>) -> Self

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.

Trait Implementations

impl Clone for UpdateClassificationJob

fn clone(&self) -> UpdateClassificationJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateClassificationJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.