aws_sdk_kms/operation/cancel_key_deletion/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::cancel_key_deletion::_cancel_key_deletion_output::CancelKeyDeletionOutputBuilder;
3
4pub use crate::operation::cancel_key_deletion::_cancel_key_deletion_input::CancelKeyDeletionInputBuilder;
5
6impl crate::operation::cancel_key_deletion::builders::CancelKeyDeletionInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::cancel_key_deletion::CancelKeyDeletionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::cancel_key_deletion::CancelKeyDeletionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.cancel_key_deletion();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CancelKeyDeletion`.
24///
25/// <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is <code>Disabled</code>. To enable the KMS key, use <code>EnableKey</code>.</p>
26/// <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
27/// <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
28/// <p><b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
29/// <p><b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CancelKeyDeletion</a> (key policy)</p>
30/// <p><b>Related operations</b>: <code>ScheduleKeyDeletion</code></p>
31/// <p><b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
32#[derive(::std::clone::Clone, ::std::fmt::Debug)]
33pub struct CancelKeyDeletionFluentBuilder {
34 handle: ::std::sync::Arc<crate::client::Handle>,
35 inner: crate::operation::cancel_key_deletion::builders::CancelKeyDeletionInputBuilder,
36 config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39 crate::client::customize::internal::CustomizableSend<
40 crate::operation::cancel_key_deletion::CancelKeyDeletionOutput,
41 crate::operation::cancel_key_deletion::CancelKeyDeletionError,
42 > for CancelKeyDeletionFluentBuilder
43{
44 fn send(
45 self,
46 config_override: crate::config::Builder,
47 ) -> crate::client::customize::internal::BoxFuture<
48 crate::client::customize::internal::SendResult<
49 crate::operation::cancel_key_deletion::CancelKeyDeletionOutput,
50 crate::operation::cancel_key_deletion::CancelKeyDeletionError,
51 >,
52 > {
53 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54 }
55}
56impl CancelKeyDeletionFluentBuilder {
57 /// Creates a new `CancelKeyDeletionFluentBuilder`.
58 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
59 Self {
60 handle,
61 inner: ::std::default::Default::default(),
62 config_override: ::std::option::Option::None,
63 }
64 }
65 /// Access the CancelKeyDeletion as a reference.
66 pub fn as_input(&self) -> &crate::operation::cancel_key_deletion::builders::CancelKeyDeletionInputBuilder {
67 &self.inner
68 }
69 /// Sends the request and returns the response.
70 ///
71 /// If an error occurs, an `SdkError` will be returned with additional details that
72 /// can be matched against.
73 ///
74 /// By default, any retryable failures will be retried twice. Retry behavior
75 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
76 /// set when configuring the client.
77 pub async fn send(
78 self,
79 ) -> ::std::result::Result<
80 crate::operation::cancel_key_deletion::CancelKeyDeletionOutput,
81 ::aws_smithy_runtime_api::client::result::SdkError<
82 crate::operation::cancel_key_deletion::CancelKeyDeletionError,
83 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
84 >,
85 > {
86 let input = self
87 .inner
88 .build()
89 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
90 let runtime_plugins = crate::operation::cancel_key_deletion::CancelKeyDeletion::operation_runtime_plugins(
91 self.handle.runtime_plugins.clone(),
92 &self.handle.conf,
93 self.config_override,
94 );
95 crate::operation::cancel_key_deletion::CancelKeyDeletion::orchestrate(&runtime_plugins, input).await
96 }
97
98 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
99 pub fn customize(
100 self,
101 ) -> crate::client::customize::CustomizableOperation<
102 crate::operation::cancel_key_deletion::CancelKeyDeletionOutput,
103 crate::operation::cancel_key_deletion::CancelKeyDeletionError,
104 Self,
105 > {
106 crate::client::customize::CustomizableOperation::new(self)
107 }
108 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
109 self.set_config_override(::std::option::Option::Some(config_override.into()));
110 self
111 }
112
113 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
114 self.config_override = config_override;
115 self
116 }
117 /// <p>Identifies the KMS key whose deletion is being canceled.</p>
118 /// <p>Specify the key ID or key ARN of the KMS key.</p>
119 /// <p>For example:</p>
120 /// <ul>
121 /// <li>
122 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
123 /// <li>
124 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
125 /// </ul>
126 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
127 pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128 self.inner = self.inner.key_id(input.into());
129 self
130 }
131 /// <p>Identifies the KMS key whose deletion is being canceled.</p>
132 /// <p>Specify the key ID or key ARN of the KMS key.</p>
133 /// <p>For example:</p>
134 /// <ul>
135 /// <li>
136 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
137 /// <li>
138 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
139 /// </ul>
140 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
141 pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142 self.inner = self.inner.set_key_id(input);
143 self
144 }
145 /// <p>Identifies the KMS key whose deletion is being canceled.</p>
146 /// <p>Specify the key ID or key ARN of the KMS key.</p>
147 /// <p>For example:</p>
148 /// <ul>
149 /// <li>
150 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
151 /// <li>
152 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
153 /// </ul>
154 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
155 pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
156 self.inner.get_key_id()
157 }
158}