aws_sdk_kms/operation/
update_custom_key_store.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `UpdateCustomKeyStore`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct UpdateCustomKeyStore;
6impl UpdateCustomKeyStore {
7    /// Creates a new `UpdateCustomKeyStore`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::update_custom_key_store::UpdateCustomKeyStoreInput,
14    ) -> ::std::result::Result<
15        crate::operation::update_custom_key_store::UpdateCustomKeyStoreOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::update_custom_key_store::UpdateCustomKeyStoreError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::update_custom_key_store::UpdateCustomKeyStoreError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::update_custom_key_store::UpdateCustomKeyStoreOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::update_custom_key_store::UpdateCustomKeyStoreInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("KMS", "UpdateCustomKeyStore", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "KMS.UpdateCustomKeyStore",
59                "rpc.service" = "KMS",
60                "rpc.method" = "UpdateCustomKeyStore",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for UpdateCustomKeyStore {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("UpdateCustomKeyStore");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            UpdateCustomKeyStoreRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            UpdateCustomKeyStoreResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("UpdateCustomKeyStore")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "UpdateCustomKeyStore",
107            "KMS",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("UpdateCustomKeyStore")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                UpdateCustomKeyStoreTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                UpdateCustomKeyStoreEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::update_custom_key_store::UpdateCustomKeyStoreError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::update_custom_key_store::UpdateCustomKeyStoreError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::update_custom_key_store::UpdateCustomKeyStoreError,
146            >::new())
147            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
148                crate::operation::update_custom_key_store::UpdateCustomKeyStoreError,
149            >::new());
150
151        ::std::borrow::Cow::Owned(rcb)
152    }
153}
154
155#[derive(Debug)]
156struct UpdateCustomKeyStoreTelemetryInputCaptureInterceptor;
157
158#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
159impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UpdateCustomKeyStoreTelemetryInputCaptureInterceptor {
160    fn name(&self) -> &'static str {
161        "UpdateCustomKeyStoreTelemetryInputCaptureInterceptor"
162    }
163
164    fn read_before_execution(
165        &self,
166        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
167            '_,
168            ::aws_smithy_runtime_api::client::interceptors::context::Input,
169            ::aws_smithy_runtime_api::client::interceptors::context::Output,
170            ::aws_smithy_runtime_api::client::interceptors::context::Error,
171        >,
172        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
174        // Nothing to do unless the customer opted in by naming members to record.
175        let ::std::option::Option::Some(requested) = cfg
176            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
177            .filter(|r| !r.is_empty())
178        else {
179            return ::std::result::Result::Ok(());
180        };
181
182        let ::std::option::Option::Some(input) = context.input().downcast_ref::<UpdateCustomKeyStoreInput>() else {
183            // A mismatched input is not this interceptor's concern; skip quietly.
184            return ::std::result::Result::Ok(());
185        };
186
187        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
188        if requested.should_capture("CustomKeyStoreId") {
189            if let ::std::option::Option::Some(value) = input.custom_key_store_id.as_deref() {
190                captured.insert("CustomKeyStoreId", value);
191            }
192        }
193        if requested.should_capture("NewCustomKeyStoreName") {
194            if let ::std::option::Option::Some(value) = input.new_custom_key_store_name.as_deref() {
195                captured.insert("NewCustomKeyStoreName", value);
196            }
197        }
198        if requested.should_capture("CloudHsmClusterId") {
199            if let ::std::option::Option::Some(value) = input.cloud_hsm_cluster_id.as_deref() {
200                captured.insert("CloudHsmClusterId", value);
201            }
202        }
203        if requested.should_capture("XksProxyUriEndpoint") {
204            if let ::std::option::Option::Some(value) = input.xks_proxy_uri_endpoint.as_deref() {
205                captured.insert("XksProxyUriEndpoint", value);
206            }
207        }
208        if requested.should_capture("XksProxyUriPath") {
209            if let ::std::option::Option::Some(value) = input.xks_proxy_uri_path.as_deref() {
210                captured.insert("XksProxyUriPath", value);
211            }
212        }
213        if requested.should_capture("XksProxyVpcEndpointServiceName") {
214            if let ::std::option::Option::Some(value) = input.xks_proxy_vpc_endpoint_service_name.as_deref() {
215                captured.insert("XksProxyVpcEndpointServiceName", value);
216            }
217        }
218        if requested.should_capture("XksProxyVpcEndpointServiceOwner") {
219            if let ::std::option::Option::Some(value) = input.xks_proxy_vpc_endpoint_service_owner.as_deref() {
220                captured.insert("XksProxyVpcEndpointServiceOwner", value);
221            }
222        }
223
224        cfg.interceptor_state().store_put(captured);
225        ::std::result::Result::Ok(())
226    }
227}
228#[derive(Debug)]
229struct UpdateCustomKeyStoreResponseDeserializer;
230impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for UpdateCustomKeyStoreResponseDeserializer {
231    fn deserialize_nonstreaming_with_config(
232        &self,
233        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
234        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
235    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
236        let (success, status) = (response.status().is_success(), response.status().as_u16());
237        let headers = response.headers();
238        let body = response.body().bytes().expect("body loaded");
239        #[allow(unused_mut)]
240        let mut force_error = false;
241        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
242        let parse_result = if !success && status != 200 || force_error {
243            crate::protocol_serde::shape_update_custom_key_store::de_update_custom_key_store_http_error(status, headers, body, _cfg)
244        } else {
245            crate::protocol_serde::shape_update_custom_key_store::de_update_custom_key_store_http_response(status, headers, body, _cfg)
246        };
247        crate::protocol_serde::type_erase_result(parse_result)
248    }
249}
250#[derive(Debug)]
251struct UpdateCustomKeyStoreRequestSerializer;
252impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for UpdateCustomKeyStoreRequestSerializer {
253    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
254    fn serialize_input(
255        &self,
256        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
257        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
258    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
259        let input = input
260            .downcast::<crate::operation::update_custom_key_store::UpdateCustomKeyStoreInput>()
261            .expect("correct type");
262        let _header_serialization_settings = _cfg
263            .load::<crate::serialization_settings::HeaderSerializationSettings>()
264            .cloned()
265            .unwrap_or_default();
266        let mut request_builder = {
267            #[allow(clippy::uninlined_format_args)]
268            fn uri_base(
269                _input: &crate::operation::update_custom_key_store::UpdateCustomKeyStoreInput,
270                output: &mut ::std::string::String,
271            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
272                use ::std::fmt::Write as _;
273                ::std::write!(output, "/").expect("formatting should succeed");
274                ::std::result::Result::Ok(())
275            }
276            #[allow(clippy::unnecessary_wraps)]
277            fn update_http_builder(
278                input: &crate::operation::update_custom_key_store::UpdateCustomKeyStoreInput,
279                builder: ::http_1x::request::Builder,
280            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
281                let mut uri = ::std::string::String::new();
282                uri_base(input, &mut uri)?;
283                ::std::result::Result::Ok(builder.method("POST").uri(uri))
284            }
285            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
286            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
287            builder = _header_serialization_settings.set_default_header(
288                builder,
289                ::http_1x::header::HeaderName::from_static("x-amz-target"),
290                "TrentService.UpdateCustomKeyStore",
291            );
292            builder
293        };
294        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_update_custom_key_store::ser_update_custom_key_store_input(
295            &input,
296        )?);
297        if let Some(content_length) = body.content_length() {
298            let content_length = content_length.to_string();
299            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
300        }
301        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
302    }
303}
304#[derive(Debug)]
305struct UpdateCustomKeyStoreEndpointParamsInterceptor;
306
307#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
308impl ::aws_smithy_runtime_api::client::interceptors::Intercept for UpdateCustomKeyStoreEndpointParamsInterceptor {
309    fn name(&self) -> &'static str {
310        "UpdateCustomKeyStoreEndpointParamsInterceptor"
311    }
312
313    fn read_before_execution(
314        &self,
315        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
316            '_,
317            ::aws_smithy_runtime_api::client::interceptors::context::Input,
318            ::aws_smithy_runtime_api::client::interceptors::context::Output,
319            ::aws_smithy_runtime_api::client::interceptors::context::Error,
320        >,
321        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
322    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
323        let _input = context
324            .input()
325            .downcast_ref::<UpdateCustomKeyStoreInput>()
326            .ok_or("failed to downcast to UpdateCustomKeyStoreInput")?;
327
328        let params = crate::config::endpoint::Params::builder()
329            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
330            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
331            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
332            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
333            .build()
334            .map_err(|err| {
335                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
336            })?;
337        cfg.interceptor_state()
338            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
339        ::std::result::Result::Ok(())
340    }
341}
342
343// The get_* functions below are generated from JMESPath expressions in the
344// operationContextParams trait. They target the operation's input shape.
345
346/// Error type for the `UpdateCustomKeyStoreError` operation.
347#[non_exhaustive]
348#[derive(::std::fmt::Debug)]
349pub enum UpdateCustomKeyStoreError {
350    /// <p>The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.</p>
351    /// <ul>
352    /// <li>
353    /// <p>The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.</p></li>
354    /// <li>
355    /// <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for the cluster</a> (cloudhsm-cluster-<i><cluster-id></cluster-id></i>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p></li>
356    /// <li>
357    /// <p>The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p>
358    /// <p>For the <code>CreateCustomKeyStore</code>, <code>UpdateCustomKeyStore</code>, and <code>CreateKey</code> operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the <code>ConnectCustomKeyStore</code> operation, the CloudHSM must contain at least one active HSM.</p></li>
359    /// </ul>
360    /// <p>For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>Key Management Service Developer Guide</i>. For information about creating a private subnet for an CloudHSM cluster, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private Subnet</a> in the <i>CloudHSM User Guide</i>. For information about cluster security groups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security Group</a> in the <i> <i>CloudHSM User Guide</i> </i>.</p>
361    CloudHsmClusterInvalidConfigurationException(crate::types::error::CloudHsmClusterInvalidConfigurationException),
362    /// <p>The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>CloudHSM User Guide</i>.</p>
363    CloudHsmClusterNotActiveException(crate::types::error::CloudHsmClusterNotActiveException),
364    /// <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.</p>
365    CloudHsmClusterNotFoundException(crate::types::error::CloudHsmClusterNotFoundException),
366    /// <p>The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.</p>
367    /// <p>Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.</p>
368    /// <p>CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
369    CloudHsmClusterNotRelatedException(crate::types::error::CloudHsmClusterNotRelatedException),
370    /// <p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <code>DescribeCustomKeyStores</code> operation.</p>
371    /// <p>This exception is thrown under the following conditions:</p>
372    /// <ul>
373    /// <li>
374    /// <p>You requested the <code>ConnectCustomKeyStore</code> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values. To reconnect a custom key store in a <code>FAILED</code> state, disconnect it (<code>DisconnectCustomKeyStore</code>), then connect it (<code>ConnectCustomKeyStore</code>).</p></li>
375    /// <li>
376    /// <p>You requested the <code>CreateKey</code> operation in a custom key store that is not connected. This operations is valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p></li>
377    /// <li>
378    /// <p>You requested the <code>DisconnectCustomKeyStore</code> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>DISCONNECTED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p></li>
379    /// <li>
380    /// <p>You requested the <code>UpdateCustomKeyStore</code> or <code>DeleteCustomKeyStore</code> operation on a custom key store that is not disconnected. <code>UpdateCustomKeyStore</code> can be called on a custom key store in the <code>CONNECTED</code> state only to update <code>NewCustomKeyStoreName</code>. For all other properties, the custom key store <code>ConnectionState</code> must be <code>DISCONNECTED</code>.</p></li>
381    /// <li>
382    /// <p>You requested the <code>GenerateRandom</code> operation in an CloudHSM key store that is not connected. This operation is valid only when the CloudHSM key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p></li>
383    /// </ul>
384    CustomKeyStoreInvalidStateException(crate::types::error::CustomKeyStoreInvalidStateException),
385    /// <p>The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.</p>
386    CustomKeyStoreNameInUseException(crate::types::error::CustomKeyStoreNameInUseException),
387    /// <p>The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.</p>
388    CustomKeyStoreNotFoundException(crate::types::error::CustomKeyStoreNotFoundException),
389    /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
390    KmsInternalException(crate::types::error::KmsInternalException),
391    /// <p>The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.</p>
392    XksProxyIncorrectAuthenticationCredentialException(crate::types::error::XksProxyIncorrectAuthenticationCredentialException),
393    /// <p>The request was rejected because the external key store proxy is not configured correctly. To identify the cause, see the error message that accompanies the exception.</p>
394    XksProxyInvalidConfigurationException(crate::types::error::XksProxyInvalidConfigurationException),
395    /// <p></p>
396    /// <p>KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.</p>
397    XksProxyInvalidResponseException(crate::types::error::XksProxyInvalidResponseException),
398    /// <p>The request was rejected because the <code>XksProxyUriEndpoint</code> is already associated with another external key store in this Amazon Web Services Region. To identify the cause, see the error message that accompanies the exception.</p>
399    XksProxyUriEndpointInUseException(crate::types::error::XksProxyUriEndpointInUseException),
400    /// <p>The request was rejected because the concatenation of the <code>XksProxyUriEndpoint</code> and <code>XksProxyUriPath</code> is already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy API address.</p>
401    XksProxyUriInUseException(crate::types::error::XksProxyUriInUseException),
402    /// <p>KMS was unable to reach the specified <code>XksProxyUriPath</code>. The path must be reachable before you create the external key store or update its settings.</p>
403    /// <p>This exception is also thrown when the external key store proxy response to a <code>GetHealthStatus</code> request indicates that all external key manager instances are unavailable.</p>
404    XksProxyUriUnreachableException(crate::types::error::XksProxyUriUnreachableException),
405    /// <p>The request was rejected because the specified Amazon VPC endpoint service is already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a different Amazon VPC endpoint service.</p>
406    XksProxyVpcEndpointServiceInUseException(crate::types::error::XksProxyVpcEndpointServiceInUseException),
407    /// <p>The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store. To identify the cause, see the error message that accompanies the exception and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements">review the requirements</a> for Amazon VPC endpoint service connectivity for an external key store.</p>
408    XksProxyVpcEndpointServiceInvalidConfigurationException(crate::types::error::XksProxyVpcEndpointServiceInvalidConfigurationException),
409    /// <p>The request was rejected because KMS could not find the specified VPC endpoint service. Use <code>DescribeCustomKeyStores</code> to verify the VPC endpoint service name for the external key store. Also, confirm that the <code>Allow principals</code> list for the VPC endpoint service includes the KMS service principal for the Region, such as <code>cks.kms.us-east-1.amazonaws.com</code>.</p>
410    XksProxyVpcEndpointServiceNotFoundException(crate::types::error::XksProxyVpcEndpointServiceNotFoundException),
411    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
412    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
413    variable wildcard pattern and check `.code()`:
414     \
415    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
416     \
417    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-UpdateCustomKeyStoreError) for what information is available for the error.")]
418    Unhandled(crate::error::sealed_unhandled::Unhandled),
419}
420impl UpdateCustomKeyStoreError {
421    /// Creates the `UpdateCustomKeyStoreError::Unhandled` variant from any error type.
422    pub fn unhandled(
423        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
424    ) -> Self {
425        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
426            source: err.into(),
427            meta: ::std::default::Default::default(),
428        })
429    }
430
431    /// Creates the `UpdateCustomKeyStoreError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
432    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
433        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
434            source: err.clone().into(),
435            meta: err,
436        })
437    }
438    ///
439    /// Returns error metadata, which includes the error code, message,
440    /// request ID, and potentially additional information.
441    ///
442    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
443        match self {
444            Self::CloudHsmClusterInvalidConfigurationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
445            Self::CloudHsmClusterNotActiveException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
446            Self::CloudHsmClusterNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
447            Self::CloudHsmClusterNotRelatedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
448            Self::CustomKeyStoreInvalidStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
449            Self::CustomKeyStoreNameInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
450            Self::CustomKeyStoreNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
451            Self::KmsInternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
452            Self::XksProxyIncorrectAuthenticationCredentialException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
453            Self::XksProxyInvalidConfigurationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
454            Self::XksProxyInvalidResponseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
455            Self::XksProxyUriEndpointInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
456            Self::XksProxyUriInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
457            Self::XksProxyUriUnreachableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
458            Self::XksProxyVpcEndpointServiceInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
459            Self::XksProxyVpcEndpointServiceInvalidConfigurationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
460            Self::XksProxyVpcEndpointServiceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
461            Self::Unhandled(e) => &e.meta,
462        }
463    }
464    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CloudHsmClusterInvalidConfigurationException`.
465    pub fn is_cloud_hsm_cluster_invalid_configuration_exception(&self) -> bool {
466        matches!(self, Self::CloudHsmClusterInvalidConfigurationException(_))
467    }
468    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CloudHsmClusterNotActiveException`.
469    pub fn is_cloud_hsm_cluster_not_active_exception(&self) -> bool {
470        matches!(self, Self::CloudHsmClusterNotActiveException(_))
471    }
472    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CloudHsmClusterNotFoundException`.
473    pub fn is_cloud_hsm_cluster_not_found_exception(&self) -> bool {
474        matches!(self, Self::CloudHsmClusterNotFoundException(_))
475    }
476    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CloudHsmClusterNotRelatedException`.
477    pub fn is_cloud_hsm_cluster_not_related_exception(&self) -> bool {
478        matches!(self, Self::CloudHsmClusterNotRelatedException(_))
479    }
480    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CustomKeyStoreInvalidStateException`.
481    pub fn is_custom_key_store_invalid_state_exception(&self) -> bool {
482        matches!(self, Self::CustomKeyStoreInvalidStateException(_))
483    }
484    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CustomKeyStoreNameInUseException`.
485    pub fn is_custom_key_store_name_in_use_exception(&self) -> bool {
486        matches!(self, Self::CustomKeyStoreNameInUseException(_))
487    }
488    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::CustomKeyStoreNotFoundException`.
489    pub fn is_custom_key_store_not_found_exception(&self) -> bool {
490        matches!(self, Self::CustomKeyStoreNotFoundException(_))
491    }
492    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::KmsInternalException`.
493    pub fn is_kms_internal_exception(&self) -> bool {
494        matches!(self, Self::KmsInternalException(_))
495    }
496    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyIncorrectAuthenticationCredentialException`.
497    pub fn is_xks_proxy_incorrect_authentication_credential_exception(&self) -> bool {
498        matches!(self, Self::XksProxyIncorrectAuthenticationCredentialException(_))
499    }
500    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyInvalidConfigurationException`.
501    pub fn is_xks_proxy_invalid_configuration_exception(&self) -> bool {
502        matches!(self, Self::XksProxyInvalidConfigurationException(_))
503    }
504    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyInvalidResponseException`.
505    pub fn is_xks_proxy_invalid_response_exception(&self) -> bool {
506        matches!(self, Self::XksProxyInvalidResponseException(_))
507    }
508    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyUriEndpointInUseException`.
509    pub fn is_xks_proxy_uri_endpoint_in_use_exception(&self) -> bool {
510        matches!(self, Self::XksProxyUriEndpointInUseException(_))
511    }
512    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyUriInUseException`.
513    pub fn is_xks_proxy_uri_in_use_exception(&self) -> bool {
514        matches!(self, Self::XksProxyUriInUseException(_))
515    }
516    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyUriUnreachableException`.
517    pub fn is_xks_proxy_uri_unreachable_exception(&self) -> bool {
518        matches!(self, Self::XksProxyUriUnreachableException(_))
519    }
520    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceInUseException`.
521    pub fn is_xks_proxy_vpc_endpoint_service_in_use_exception(&self) -> bool {
522        matches!(self, Self::XksProxyVpcEndpointServiceInUseException(_))
523    }
524    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceInvalidConfigurationException`.
525    pub fn is_xks_proxy_vpc_endpoint_service_invalid_configuration_exception(&self) -> bool {
526        matches!(self, Self::XksProxyVpcEndpointServiceInvalidConfigurationException(_))
527    }
528    /// Returns `true` if the error kind is `UpdateCustomKeyStoreError::XksProxyVpcEndpointServiceNotFoundException`.
529    pub fn is_xks_proxy_vpc_endpoint_service_not_found_exception(&self) -> bool {
530        matches!(self, Self::XksProxyVpcEndpointServiceNotFoundException(_))
531    }
532}
533impl ::std::error::Error for UpdateCustomKeyStoreError {
534    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
535        match self {
536            Self::CloudHsmClusterInvalidConfigurationException(_inner) => ::std::option::Option::Some(_inner),
537            Self::CloudHsmClusterNotActiveException(_inner) => ::std::option::Option::Some(_inner),
538            Self::CloudHsmClusterNotFoundException(_inner) => ::std::option::Option::Some(_inner),
539            Self::CloudHsmClusterNotRelatedException(_inner) => ::std::option::Option::Some(_inner),
540            Self::CustomKeyStoreInvalidStateException(_inner) => ::std::option::Option::Some(_inner),
541            Self::CustomKeyStoreNameInUseException(_inner) => ::std::option::Option::Some(_inner),
542            Self::CustomKeyStoreNotFoundException(_inner) => ::std::option::Option::Some(_inner),
543            Self::KmsInternalException(_inner) => ::std::option::Option::Some(_inner),
544            Self::XksProxyIncorrectAuthenticationCredentialException(_inner) => ::std::option::Option::Some(_inner),
545            Self::XksProxyInvalidConfigurationException(_inner) => ::std::option::Option::Some(_inner),
546            Self::XksProxyInvalidResponseException(_inner) => ::std::option::Option::Some(_inner),
547            Self::XksProxyUriEndpointInUseException(_inner) => ::std::option::Option::Some(_inner),
548            Self::XksProxyUriInUseException(_inner) => ::std::option::Option::Some(_inner),
549            Self::XksProxyUriUnreachableException(_inner) => ::std::option::Option::Some(_inner),
550            Self::XksProxyVpcEndpointServiceInUseException(_inner) => ::std::option::Option::Some(_inner),
551            Self::XksProxyVpcEndpointServiceInvalidConfigurationException(_inner) => ::std::option::Option::Some(_inner),
552            Self::XksProxyVpcEndpointServiceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
553            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
554        }
555    }
556}
557impl ::std::fmt::Display for UpdateCustomKeyStoreError {
558    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
559        match self {
560            Self::CloudHsmClusterInvalidConfigurationException(_inner) => _inner.fmt(f),
561            Self::CloudHsmClusterNotActiveException(_inner) => _inner.fmt(f),
562            Self::CloudHsmClusterNotFoundException(_inner) => _inner.fmt(f),
563            Self::CloudHsmClusterNotRelatedException(_inner) => _inner.fmt(f),
564            Self::CustomKeyStoreInvalidStateException(_inner) => _inner.fmt(f),
565            Self::CustomKeyStoreNameInUseException(_inner) => _inner.fmt(f),
566            Self::CustomKeyStoreNotFoundException(_inner) => _inner.fmt(f),
567            Self::KmsInternalException(_inner) => _inner.fmt(f),
568            Self::XksProxyIncorrectAuthenticationCredentialException(_inner) => _inner.fmt(f),
569            Self::XksProxyInvalidConfigurationException(_inner) => _inner.fmt(f),
570            Self::XksProxyInvalidResponseException(_inner) => _inner.fmt(f),
571            Self::XksProxyUriEndpointInUseException(_inner) => _inner.fmt(f),
572            Self::XksProxyUriInUseException(_inner) => _inner.fmt(f),
573            Self::XksProxyUriUnreachableException(_inner) => _inner.fmt(f),
574            Self::XksProxyVpcEndpointServiceInUseException(_inner) => _inner.fmt(f),
575            Self::XksProxyVpcEndpointServiceInvalidConfigurationException(_inner) => _inner.fmt(f),
576            Self::XksProxyVpcEndpointServiceNotFoundException(_inner) => _inner.fmt(f),
577            Self::Unhandled(_inner) => {
578                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
579                    write!(f, "unhandled error ({code})")
580                } else {
581                    f.write_str("unhandled error")
582                }
583            }
584        }
585    }
586}
587impl ::aws_smithy_types::retry::ProvideErrorKind for UpdateCustomKeyStoreError {
588    fn code(&self) -> ::std::option::Option<&str> {
589        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
590    }
591    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
592        ::std::option::Option::None
593    }
594}
595impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for UpdateCustomKeyStoreError {
596    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
597        match self {
598            Self::CloudHsmClusterInvalidConfigurationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
599            Self::CloudHsmClusterNotActiveException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
600            Self::CloudHsmClusterNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
601            Self::CloudHsmClusterNotRelatedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
602            Self::CustomKeyStoreInvalidStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
603            Self::CustomKeyStoreNameInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
604            Self::CustomKeyStoreNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
605            Self::KmsInternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
606            Self::XksProxyIncorrectAuthenticationCredentialException(_inner) => {
607                ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
608            }
609            Self::XksProxyInvalidConfigurationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
610            Self::XksProxyInvalidResponseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
611            Self::XksProxyUriEndpointInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
612            Self::XksProxyUriInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
613            Self::XksProxyUriUnreachableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
614            Self::XksProxyVpcEndpointServiceInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
615            Self::XksProxyVpcEndpointServiceInvalidConfigurationException(_inner) => {
616                ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner)
617            }
618            Self::XksProxyVpcEndpointServiceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
619            Self::Unhandled(_inner) => &_inner.meta,
620        }
621    }
622}
623impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for UpdateCustomKeyStoreError {
624    fn create_unhandled_error(
625        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
626        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
627    ) -> Self {
628        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
629            source,
630            meta: meta.unwrap_or_default(),
631        })
632    }
633}
634impl ::aws_types::request_id::RequestId for crate::operation::update_custom_key_store::UpdateCustomKeyStoreError {
635    fn request_id(&self) -> Option<&str> {
636        self.meta().request_id()
637    }
638}
639
640pub use crate::operation::update_custom_key_store::_update_custom_key_store_input::UpdateCustomKeyStoreInput;
641
642pub use crate::operation::update_custom_key_store::_update_custom_key_store_output::UpdateCustomKeyStoreOutput;
643
644mod _update_custom_key_store_input;
645
646mod _update_custom_key_store_output;
647
648/// Builders
649pub mod builders;
aws_sdk_kms/operation/update_custom_key_store.rs

aws_sdk_kms/operation/
update_custom_key_store.rs
