Skip to main content

aws_sdk_location/client/
cancel_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CancelJob`](crate::operation::cancel_job::builders::CancelJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::cancel_job::builders::CancelJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::cancel_job::builders::CancelJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The unique identifier of the job to cancel.</p><br>
7    /// - On success, responds with [`CancelJobOutput`](crate::operation::cancel_job::CancelJobOutput) with field(s):
8    ///   - [`job_arn(String)`](crate::operation::cancel_job::CancelJobOutput::job_arn): <p>Amazon Resource Name (ARN) of the cancelled job.</p>
9    ///   - [`job_id(String)`](crate::operation::cancel_job::CancelJobOutput::job_id): <p>Unique job identifier.</p>
10    ///   - [`status(JobStatus)`](crate::operation::cancel_job::CancelJobOutput::status): <p>Job status after cancellation request.</p>
11    /// - On failure, responds with [`SdkError<CancelJobError>`](crate::operation::cancel_job::CancelJobError)
12    pub fn cancel_job(&self) -> crate::operation::cancel_job::builders::CancelJobFluentBuilder {
13        crate::operation::cancel_job::builders::CancelJobFluentBuilder::new(self.handle.clone())
14    }
15}