Struct aws_sdk_batch::client::fluent_builders::CancelJob

pub struct CancelJob { /* private fields */ }

Fluent builder constructing a request to CancelJob.

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. 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 CancelJob

pub async fn customize(
    self
) -> Result<CustomizableOperation<CancelJob, AwsResponseRetryClassifier>, SdkError<CancelJobError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

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

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

Trait Implementations

impl Clone for CancelJob

fn clone(&self) -> CancelJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJob

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

Formats the value using the given formatter.