Struct aws_sdk_batch::operation::cancel_job::builders::CancelJobFluentBuilder

pub struct CancelJobFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CancelJob.

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED.

A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status.

When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Implementations

impl CancelJobFluentBuilder

pub fn as_input(&self) -> &CancelJobInputBuilder

Access the CancelJob as a reference.

pub async fn send( self, ) -> Result<CancelJobOutput, SdkError<CancelJobError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<CancelJobOutput, CancelJobError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The Batch job ID of the job to cancel.

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

The Batch job ID of the job to cancel.

pub fn get_job_id(&self) -> &Option<String>

The Batch job ID of the job to cancel.

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

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

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

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

pub fn get_reason(&self) -> &Option<String>

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Trait Implementations

impl Clone for CancelJobFluentBuilder

fn clone(&self) -> CancelJobFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJobFluentBuilder

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

Formats the value using the given formatter.