Struct aws_sdk_batch::client::fluent_builders::TerminateJob

pub struct TerminateJob<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to TerminateJob.

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Implementations

impl<C, M, R> TerminateJob<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<TerminateJobOutput, SdkError<TerminateJobError>> where
    R::Policy: SmithyRetryPolicy<TerminateJobInputOperationOutputAlias, TerminateJobOutput, TerminateJobError, TerminateJobInputOperationRetryAlias>, 

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

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

The Batch job ID of the job to terminate.

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<C: Clone, M: Clone, R: Clone> Clone for TerminateJob<C, M, R>

fn clone(&self) -> TerminateJob<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for TerminateJob<C, M, R>

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

Formats the value using the given formatter.