aws_sdk_storagegateway/client/cancel_retrieval.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 [`CancelRetrieval`](crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`gateway_arn(impl Into<String>)`](crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder::gateway_arn) / [`set_gateway_arn(Option<String>)`](crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder::set_gateway_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p><br>
7 /// - [`tape_arn(impl Into<String>)`](crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder::tape_arn) / [`set_tape_arn(Option<String>)`](crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder::set_tape_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.</p><br>
8 /// - On success, responds with [`CancelRetrievalOutput`](crate::operation::cancel_retrieval::CancelRetrievalOutput) with field(s):
9 /// - [`tape_arn(Option<String>)`](crate::operation::cancel_retrieval::CancelRetrievalOutput::tape_arn): <p>The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.</p>
10 /// - On failure, responds with [`SdkError<CancelRetrievalError>`](crate::operation::cancel_retrieval::CancelRetrievalError)
11 pub fn cancel_retrieval(&self) -> crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder {
12 crate::operation::cancel_retrieval::builders::CancelRetrievalFluentBuilder::new(self.handle.clone())
13 }
14}