aws_sdk_paymentcryptography/operation/
get_key.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetKey`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetKey;
6impl GetKey {
7    /// Creates a new `GetKey`
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::get_key::GetKeyInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_key::GetKeyOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_key::GetKeyError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_key::GetKeyError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(output.downcast::<crate::operation::get_key::GetKeyOutput>().expect("correct output type"))
31    }
32
33    pub(crate) async fn orchestrate_with_stop_point(
34        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
35        input: crate::operation::get_key::GetKeyInput,
36        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
37    ) -> ::std::result::Result<
38        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
39        ::aws_smithy_runtime_api::client::result::SdkError<
40            ::aws_smithy_runtime_api::client::interceptors::context::Error,
41            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
42        >,
43    > {
44        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
45        use ::tracing::Instrument;
46        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("Payment Cryptography", "GetKey", input, runtime_plugins, stop_point)
47            // Create a parent span for the entire operation. Includes a random, internal-only,
48            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
49            .instrument(::tracing::debug_span!(
50                "Payment Cryptography.GetKey",
51                "rpc.service" = "Payment Cryptography",
52                "rpc.method" = "GetKey",
53                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
54                "rpc.system" = "aws-api",
55            ))
56            .await
57    }
58
59    pub(crate) fn operation_runtime_plugins(
60        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
61        client_config: &crate::config::Config,
62        config_override: ::std::option::Option<crate::config::Builder>,
63    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
64        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
65
66        if let ::std::option::Option::Some(config_override) = config_override {
67            for plugin in config_override.runtime_plugins.iter().cloned() {
68                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
69            }
70            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
71                config_override,
72                client_config.config.clone(),
73                &client_config.runtime_components,
74            ));
75        }
76        runtime_plugins
77    }
78}
79impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetKey {
80    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetKey");
82
83        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84            GetKeyRequestSerializer,
85        ));
86        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87            GetKeyResponseDeserializer,
88        ));
89
90        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91            crate::config::auth::Params::builder()
92                .operation_name("GetKey")
93                .build()
94                .expect("required fields set"),
95        ));
96
97        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
98            "GetKey",
99            "Payment Cryptography",
100        ));
101        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
102        signing_options.double_uri_encode = true;
103        signing_options.content_sha256_header = false;
104        signing_options.normalize_uri_path = true;
105        signing_options.payload_override = None;
106
107        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
108            signing_options,
109            ..::std::default::Default::default()
110        });
111
112        ::std::option::Option::Some(cfg.freeze())
113    }
114
115    fn runtime_components(
116        &self,
117        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
118    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
119        #[allow(unused_mut)]
120        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetKey")
121            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
122                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
123            ))
124            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
125                GetKeyEndpointParamsInterceptor,
126            ))
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::get_key::GetKeyError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::get_key::GetKeyError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::get_key::GetKeyError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct GetKeyResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetKeyResponseDeserializer {
144    fn deserialize_nonstreaming_with_config(
145        &self,
146        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
147        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
148    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
149        let (success, status) = (response.status().is_success(), response.status().as_u16());
150        let headers = response.headers();
151        let body = response.body().bytes().expect("body loaded");
152        #[allow(unused_mut)]
153        let mut force_error = false;
154        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
155        let parse_result = if !success && status != 200 || force_error {
156            crate::protocol_serde::shape_get_key::de_get_key_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_get_key::de_get_key_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct GetKeyRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetKeyRequestSerializer {
166    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
167    fn serialize_input(
168        &self,
169        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
170        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
171    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
172        let input = input.downcast::<crate::operation::get_key::GetKeyInput>().expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            #[allow(clippy::uninlined_format_args)]
179            fn uri_base(
180                _input: &crate::operation::get_key::GetKeyInput,
181                output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                use ::std::fmt::Write as _;
184                ::std::write!(output, "/").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            #[allow(clippy::unnecessary_wraps)]
188            fn update_http_builder(
189                input: &crate::operation::get_key::GetKeyInput,
190                builder: ::http_1x::request::Builder,
191            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
192                let mut uri = ::std::string::String::new();
193                uri_base(input, &mut uri)?;
194                ::std::result::Result::Ok(builder.method("POST").uri(uri))
195            }
196            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
197            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.0");
198            builder = _header_serialization_settings.set_default_header(
199                builder,
200                ::http_1x::header::HeaderName::from_static("x-amz-target"),
201                "PaymentCryptographyControlPlane.GetKey",
202            );
203            builder
204        };
205        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_key::ser_get_key_input(&input)?);
206        if let Some(content_length) = body.content_length() {
207            let content_length = content_length.to_string();
208            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
209        }
210        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
211    }
212}
213#[derive(Debug)]
214struct GetKeyEndpointParamsInterceptor;
215
216#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
217impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetKeyEndpointParamsInterceptor {
218    fn name(&self) -> &'static str {
219        "GetKeyEndpointParamsInterceptor"
220    }
221
222    fn read_before_execution(
223        &self,
224        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
225            '_,
226            ::aws_smithy_runtime_api::client::interceptors::context::Input,
227            ::aws_smithy_runtime_api::client::interceptors::context::Output,
228            ::aws_smithy_runtime_api::client::interceptors::context::Error,
229        >,
230        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
231    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
232        let _input = context.input().downcast_ref::<GetKeyInput>().ok_or("failed to downcast to GetKeyInput")?;
233
234        let params = crate::config::endpoint::Params::builder()
235            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
236            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
237            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
238            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
239            .build()
240            .map_err(|err| {
241                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
242            })?;
243        cfg.interceptor_state()
244            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
245        ::std::result::Result::Ok(())
246    }
247}
248
249// The get_* functions below are generated from JMESPath expressions in the
250// operationContextParams trait. They target the operation's input shape.
251
252/// Error type for the `GetKeyError` operation.
253#[non_exhaustive]
254#[derive(::std::fmt::Debug)]
255pub enum GetKeyError {
256    /// <p>You do not have sufficient access to perform this action.</p>
257    /// <p>This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.</p>
258    AccessDeniedException(crate::types::error::AccessDeniedException),
259    /// <p>The request processing has failed because of an unknown error, exception, or failure.</p>
260    /// <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
261    InternalServerException(crate::types::error::InternalServerException),
262    /// <p>The request was denied due to resource not found.</p>
263    /// <p>The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.</p>
264    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
265    /// <p>The service cannot complete the request.</p>
266    /// <p>The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.</p>
267    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
268    /// <p>The request was denied due to request throttling.</p>
269    /// <p>You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.</p>
270    ThrottlingException(crate::types::error::ThrottlingException),
271    /// <p>The request was denied due to an invalid request error.</p>
272    /// <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
273    ValidationException(crate::types::error::ValidationException),
274    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
275    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
276    variable wildcard pattern and check `.code()`:
277     \
278    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
279     \
280    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetKeyError) for what information is available for the error.")]
281    Unhandled(crate::error::sealed_unhandled::Unhandled),
282}
283impl GetKeyError {
284    /// Creates the `GetKeyError::Unhandled` variant from any error type.
285    pub fn unhandled(
286        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
287    ) -> Self {
288        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
289            source: err.into(),
290            meta: ::std::default::Default::default(),
291        })
292    }
293
294    /// Creates the `GetKeyError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
295    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
296        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
297            source: err.clone().into(),
298            meta: err,
299        })
300    }
301    ///
302    /// Returns error metadata, which includes the error code, message,
303    /// request ID, and potentially additional information.
304    ///
305    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
306        match self {
307            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::Unhandled(e) => &e.meta,
314        }
315    }
316    /// Returns `true` if the error kind is `GetKeyError::AccessDeniedException`.
317    pub fn is_access_denied_exception(&self) -> bool {
318        matches!(self, Self::AccessDeniedException(_))
319    }
320    /// Returns `true` if the error kind is `GetKeyError::InternalServerException`.
321    pub fn is_internal_server_exception(&self) -> bool {
322        matches!(self, Self::InternalServerException(_))
323    }
324    /// Returns `true` if the error kind is `GetKeyError::ResourceNotFoundException`.
325    pub fn is_resource_not_found_exception(&self) -> bool {
326        matches!(self, Self::ResourceNotFoundException(_))
327    }
328    /// Returns `true` if the error kind is `GetKeyError::ServiceUnavailableException`.
329    pub fn is_service_unavailable_exception(&self) -> bool {
330        matches!(self, Self::ServiceUnavailableException(_))
331    }
332    /// Returns `true` if the error kind is `GetKeyError::ThrottlingException`.
333    pub fn is_throttling_exception(&self) -> bool {
334        matches!(self, Self::ThrottlingException(_))
335    }
336    /// Returns `true` if the error kind is `GetKeyError::ValidationException`.
337    pub fn is_validation_exception(&self) -> bool {
338        matches!(self, Self::ValidationException(_))
339    }
340}
341impl ::std::error::Error for GetKeyError {
342    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
343        match self {
344            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
345            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
346            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
347            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
348            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
349            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
350            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
351        }
352    }
353}
354impl ::std::fmt::Display for GetKeyError {
355    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
356        match self {
357            Self::AccessDeniedException(_inner) => _inner.fmt(f),
358            Self::InternalServerException(_inner) => _inner.fmt(f),
359            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
360            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
361            Self::ThrottlingException(_inner) => _inner.fmt(f),
362            Self::ValidationException(_inner) => _inner.fmt(f),
363            Self::Unhandled(_inner) => {
364                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
365                    write!(f, "unhandled error ({code})")
366                } else {
367                    f.write_str("unhandled error")
368                }
369            }
370        }
371    }
372}
373impl ::aws_smithy_types::retry::ProvideErrorKind for GetKeyError {
374    fn code(&self) -> ::std::option::Option<&str> {
375        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
376    }
377    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
378        ::std::option::Option::None
379    }
380}
381impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetKeyError {
382    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
383        match self {
384            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
385            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::Unhandled(_inner) => &_inner.meta,
391        }
392    }
393}
394impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetKeyError {
395    fn create_unhandled_error(
396        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
397        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
398    ) -> Self {
399        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
400            source,
401            meta: meta.unwrap_or_default(),
402        })
403    }
404}
405impl ::aws_types::request_id::RequestId for crate::operation::get_key::GetKeyError {
406    fn request_id(&self) -> Option<&str> {
407        self.meta().request_id()
408    }
409}
410
411pub use crate::operation::get_key::_get_key_input::GetKeyInput;
412
413pub use crate::operation::get_key::_get_key_output::GetKeyOutput;
414
415mod _get_key_input;
416
417mod _get_key_output;
418
419/// Builders
420pub mod builders;
aws_sdk_paymentcryptography/operation/get_key.rs

aws_sdk_paymentcryptography/operation/
get_key.rs
