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::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
122            .with_interceptor(GetKeyEndpointParamsInterceptor)
123            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
124                crate::operation::get_key::GetKeyError,
125            >::new())
126            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
127                crate::operation::get_key::GetKeyError,
128            >::new())
129            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
130                crate::operation::get_key::GetKeyError,
131            >::new());
132
133        ::std::borrow::Cow::Owned(rcb)
134    }
135}
136
137#[derive(Debug)]
138struct GetKeyResponseDeserializer;
139impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetKeyResponseDeserializer {
140    fn deserialize_nonstreaming(
141        &self,
142        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
143    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
144        let (success, status) = (response.status().is_success(), response.status().as_u16());
145        let headers = response.headers();
146        let body = response.body().bytes().expect("body loaded");
147        #[allow(unused_mut)]
148        let mut force_error = false;
149        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
150        let parse_result = if !success && status != 200 || force_error {
151            crate::protocol_serde::shape_get_key::de_get_key_http_error(status, headers, body)
152        } else {
153            crate::protocol_serde::shape_get_key::de_get_key_http_response(status, headers, body)
154        };
155        crate::protocol_serde::type_erase_result(parse_result)
156    }
157}
158#[derive(Debug)]
159struct GetKeyRequestSerializer;
160impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetKeyRequestSerializer {
161    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
162    fn serialize_input(
163        &self,
164        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
165        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
166    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
167        let input = input.downcast::<crate::operation::get_key::GetKeyInput>().expect("correct type");
168        let _header_serialization_settings = _cfg
169            .load::<crate::serialization_settings::HeaderSerializationSettings>()
170            .cloned()
171            .unwrap_or_default();
172        let mut request_builder = {
173            #[allow(clippy::uninlined_format_args)]
174            fn uri_base(
175                _input: &crate::operation::get_key::GetKeyInput,
176                output: &mut ::std::string::String,
177            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
178                use ::std::fmt::Write as _;
179                ::std::write!(output, "/").expect("formatting should succeed");
180                ::std::result::Result::Ok(())
181            }
182            #[allow(clippy::unnecessary_wraps)]
183            fn update_http_builder(
184                input: &crate::operation::get_key::GetKeyInput,
185                builder: ::http::request::Builder,
186            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
187                let mut uri = ::std::string::String::new();
188                uri_base(input, &mut uri)?;
189                ::std::result::Result::Ok(builder.method("POST").uri(uri))
190            }
191            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
192            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
193            builder = _header_serialization_settings.set_default_header(
194                builder,
195                ::http::header::HeaderName::from_static("x-amz-target"),
196                "PaymentCryptographyControlPlane.GetKey",
197            );
198            builder
199        };
200        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_key::ser_get_key_input(&input)?);
201        if let Some(content_length) = body.content_length() {
202            let content_length = content_length.to_string();
203            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
204        }
205        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
206    }
207}
208#[derive(Debug)]
209struct GetKeyEndpointParamsInterceptor;
210
211impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetKeyEndpointParamsInterceptor {
212    fn name(&self) -> &'static str {
213        "GetKeyEndpointParamsInterceptor"
214    }
215
216    fn read_before_execution(
217        &self,
218        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
219            '_,
220            ::aws_smithy_runtime_api::client::interceptors::context::Input,
221            ::aws_smithy_runtime_api::client::interceptors::context::Output,
222            ::aws_smithy_runtime_api::client::interceptors::context::Error,
223        >,
224        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
226        let _input = context.input().downcast_ref::<GetKeyInput>().ok_or("failed to downcast to GetKeyInput")?;
227
228        let params = crate::config::endpoint::Params::builder()
229            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
230            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
231            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
232            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
233            .build()
234            .map_err(|err| {
235                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
236            })?;
237        cfg.interceptor_state()
238            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
239        ::std::result::Result::Ok(())
240    }
241}
242
243// The get_* functions below are generated from JMESPath expressions in the
244// operationContextParams trait. They target the operation's input shape.
245
246/// Error type for the `GetKeyError` operation.
247#[non_exhaustive]
248#[derive(::std::fmt::Debug)]
249pub enum GetKeyError {
250    /// <p>You do not have sufficient access to perform this action.</p>
251    /// <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>
252    AccessDeniedException(crate::types::error::AccessDeniedException),
253    /// <p>The request processing has failed because of an unknown error, exception, or failure.</p>
254    /// <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
255    InternalServerException(crate::types::error::InternalServerException),
256    /// <p>The request was denied due to resource not found.</p>
257    /// <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>
258    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
259    /// <p>The service cannot complete the request.</p>
260    /// <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>
261    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
262    /// <p>The request was denied due to request throttling.</p>
263    /// <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>
264    ThrottlingException(crate::types::error::ThrottlingException),
265    /// <p>The request was denied due to an invalid request error.</p>
266    /// <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
267    ValidationException(crate::types::error::ValidationException),
268    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
269    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
270    variable wildcard pattern and check `.code()`:
271     \
272    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
273     \
274    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetKeyError) for what information is available for the error.")]
275    Unhandled(crate::error::sealed_unhandled::Unhandled),
276}
277impl GetKeyError {
278    /// Creates the `GetKeyError::Unhandled` variant from any error type.
279    pub fn unhandled(
280        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
281    ) -> Self {
282        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
283            source: err.into(),
284            meta: ::std::default::Default::default(),
285        })
286    }
287
288    /// Creates the `GetKeyError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
289    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
290        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
291            source: err.clone().into(),
292            meta: err,
293        })
294    }
295    ///
296    /// Returns error metadata, which includes the error code, message,
297    /// request ID, and potentially additional information.
298    ///
299    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
300        match self {
301            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
304            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
305            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::Unhandled(e) => &e.meta,
308        }
309    }
310    /// Returns `true` if the error kind is `GetKeyError::AccessDeniedException`.
311    pub fn is_access_denied_exception(&self) -> bool {
312        matches!(self, Self::AccessDeniedException(_))
313    }
314    /// Returns `true` if the error kind is `GetKeyError::InternalServerException`.
315    pub fn is_internal_server_exception(&self) -> bool {
316        matches!(self, Self::InternalServerException(_))
317    }
318    /// Returns `true` if the error kind is `GetKeyError::ResourceNotFoundException`.
319    pub fn is_resource_not_found_exception(&self) -> bool {
320        matches!(self, Self::ResourceNotFoundException(_))
321    }
322    /// Returns `true` if the error kind is `GetKeyError::ServiceUnavailableException`.
323    pub fn is_service_unavailable_exception(&self) -> bool {
324        matches!(self, Self::ServiceUnavailableException(_))
325    }
326    /// Returns `true` if the error kind is `GetKeyError::ThrottlingException`.
327    pub fn is_throttling_exception(&self) -> bool {
328        matches!(self, Self::ThrottlingException(_))
329    }
330    /// Returns `true` if the error kind is `GetKeyError::ValidationException`.
331    pub fn is_validation_exception(&self) -> bool {
332        matches!(self, Self::ValidationException(_))
333    }
334}
335impl ::std::error::Error for GetKeyError {
336    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
337        match self {
338            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
339            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
340            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
341            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
342            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
343            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
344            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
345        }
346    }
347}
348impl ::std::fmt::Display for GetKeyError {
349    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
350        match self {
351            Self::AccessDeniedException(_inner) => _inner.fmt(f),
352            Self::InternalServerException(_inner) => _inner.fmt(f),
353            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
354            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
355            Self::ThrottlingException(_inner) => _inner.fmt(f),
356            Self::ValidationException(_inner) => _inner.fmt(f),
357            Self::Unhandled(_inner) => {
358                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
359                    write!(f, "unhandled error ({code})")
360                } else {
361                    f.write_str("unhandled error")
362                }
363            }
364        }
365    }
366}
367impl ::aws_smithy_types::retry::ProvideErrorKind for GetKeyError {
368    fn code(&self) -> ::std::option::Option<&str> {
369        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
370    }
371    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
372        ::std::option::Option::None
373    }
374}
375impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetKeyError {
376    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
377        match self {
378            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
379            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
380            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
381            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
382            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
383            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::Unhandled(_inner) => &_inner.meta,
385        }
386    }
387}
388impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetKeyError {
389    fn create_unhandled_error(
390        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
391        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
392    ) -> Self {
393        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
394            source,
395            meta: meta.unwrap_or_default(),
396        })
397    }
398}
399impl ::aws_types::request_id::RequestId for crate::operation::get_key::GetKeyError {
400    fn request_id(&self) -> Option<&str> {
401        self.meta().request_id()
402    }
403}
404
405pub use crate::operation::get_key::_get_key_output::GetKeyOutput;
406
407pub use crate::operation::get_key::_get_key_input::GetKeyInput;
408
409mod _get_key_input;
410
411mod _get_key_output;
412
413/// Builders
414pub mod builders;
aws_sdk_paymentcryptography/operation/get_key.rs

aws_sdk_paymentcryptography/operation/
get_key.rs
