aws_sdk_quicksight/operation/
describe_key_registration.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeKeyRegistration`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeKeyRegistration;
6impl DescribeKeyRegistration {
7    /// Creates a new `DescribeKeyRegistration`
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::describe_key_registration::DescribeKeyRegistrationInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_key_registration::DescribeKeyRegistrationOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_key_registration::DescribeKeyRegistrationError,
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::describe_key_registration::DescribeKeyRegistrationError>()
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::describe_key_registration::DescribeKeyRegistrationOutput>()
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::describe_key_registration::DescribeKeyRegistrationInput,
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(
55            "QuickSight",
56            "DescribeKeyRegistration",
57            input,
58            runtime_plugins,
59            stop_point,
60        )
61        // Create a parent span for the entire operation. Includes a random, internal-only,
62        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
63        .instrument(::tracing::debug_span!(
64            "QuickSight.DescribeKeyRegistration",
65            "rpc.service" = "QuickSight",
66            "rpc.method" = "DescribeKeyRegistration",
67            "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
68            "rpc.system" = "aws-api",
69        ))
70        .await
71    }
72
73    pub(crate) fn operation_runtime_plugins(
74        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
75        client_config: &crate::config::Config,
76        config_override: ::std::option::Option<crate::config::Builder>,
77    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
78        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
79
80        if let ::std::option::Option::Some(config_override) = config_override {
81            for plugin in config_override.runtime_plugins.iter().cloned() {
82                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
83            }
84            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
85                config_override,
86                client_config.config.clone(),
87                &client_config.runtime_components,
88            ));
89        }
90        runtime_plugins
91    }
92}
93impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeKeyRegistration {
94    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
95        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeKeyRegistration");
96
97        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
98            DescribeKeyRegistrationRequestSerializer,
99        ));
100        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
101            DescribeKeyRegistrationResponseDeserializer,
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
105            crate::config::auth::Params::builder()
106                .operation_name("DescribeKeyRegistration")
107                .build()
108                .expect("required fields set"),
109        ));
110
111        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
112            "DescribeKeyRegistration",
113            "QuickSight",
114        ));
115        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
116        signing_options.double_uri_encode = true;
117        signing_options.content_sha256_header = false;
118        signing_options.normalize_uri_path = true;
119        signing_options.payload_override = None;
120
121        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
122            signing_options,
123            ..::std::default::Default::default()
124        });
125
126        ::std::option::Option::Some(cfg.freeze())
127    }
128
129    fn runtime_components(
130        &self,
131        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
132    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
133        #[allow(unused_mut)]
134        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeKeyRegistration")
135            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
136            .with_interceptor(DescribeKeyRegistrationEndpointParamsInterceptor)
137            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
138                crate::operation::describe_key_registration::DescribeKeyRegistrationError,
139            >::new())
140            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
141                crate::operation::describe_key_registration::DescribeKeyRegistrationError,
142            >::new())
143            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
144                crate::operation::describe_key_registration::DescribeKeyRegistrationError,
145            >::new());
146
147        ::std::borrow::Cow::Owned(rcb)
148    }
149}
150
151#[derive(Debug)]
152struct DescribeKeyRegistrationResponseDeserializer;
153impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeKeyRegistrationResponseDeserializer {
154    fn deserialize_nonstreaming(
155        &self,
156        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
157    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
158        let (success, status) = (response.status().is_success(), response.status().as_u16());
159        let headers = response.headers();
160        let body = response.body().bytes().expect("body loaded");
161        #[allow(unused_mut)]
162        let mut force_error = false;
163        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
164        let parse_result = if !success && status != 200 || force_error {
165            crate::protocol_serde::shape_describe_key_registration::de_describe_key_registration_http_error(status, headers, body)
166        } else {
167            crate::protocol_serde::shape_describe_key_registration::de_describe_key_registration_http_response(status, headers, body)
168        };
169        crate::protocol_serde::type_erase_result(parse_result)
170    }
171}
172#[derive(Debug)]
173struct DescribeKeyRegistrationRequestSerializer;
174impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeKeyRegistrationRequestSerializer {
175    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
176    fn serialize_input(
177        &self,
178        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
179        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
180    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
181        let input = input
182            .downcast::<crate::operation::describe_key_registration::DescribeKeyRegistrationInput>()
183            .expect("correct type");
184        let _header_serialization_settings = _cfg
185            .load::<crate::serialization_settings::HeaderSerializationSettings>()
186            .cloned()
187            .unwrap_or_default();
188        let mut request_builder = {
189            #[allow(clippy::uninlined_format_args)]
190            fn uri_base(
191                _input: &crate::operation::describe_key_registration::DescribeKeyRegistrationInput,
192                output: &mut ::std::string::String,
193            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
194                use ::std::fmt::Write as _;
195                let input_1 = &_input.aws_account_id;
196                let input_1 = input_1
197                    .as_ref()
198                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
199                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
200                if aws_account_id.is_empty() {
201                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
202                        "aws_account_id",
203                        "cannot be empty or unset",
204                    ));
205                }
206                ::std::write!(output, "/accounts/{AwsAccountId}/key-registration", AwsAccountId = aws_account_id).expect("formatting should succeed");
207                ::std::result::Result::Ok(())
208            }
209            fn uri_query(
210                _input: &crate::operation::describe_key_registration::DescribeKeyRegistrationInput,
211                mut output: &mut ::std::string::String,
212            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
213                let mut query = ::aws_smithy_http::query::Writer::new(output);
214                if let ::std::option::Option::Some(inner_2) = &_input.default_key_only {
215                    {
216                        query.push_kv("default-key-only", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
217                    }
218                }
219                ::std::result::Result::Ok(())
220            }
221            #[allow(clippy::unnecessary_wraps)]
222            fn update_http_builder(
223                input: &crate::operation::describe_key_registration::DescribeKeyRegistrationInput,
224                builder: ::http::request::Builder,
225            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
226                let mut uri = ::std::string::String::new();
227                uri_base(input, &mut uri)?;
228                uri_query(input, &mut uri)?;
229                ::std::result::Result::Ok(builder.method("GET").uri(uri))
230            }
231            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
232            builder
233        };
234        let body = ::aws_smithy_types::body::SdkBody::from("");
235
236        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
237    }
238}
239#[derive(Debug)]
240struct DescribeKeyRegistrationEndpointParamsInterceptor;
241
242impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeKeyRegistrationEndpointParamsInterceptor {
243    fn name(&self) -> &'static str {
244        "DescribeKeyRegistrationEndpointParamsInterceptor"
245    }
246
247    fn read_before_execution(
248        &self,
249        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
250            '_,
251            ::aws_smithy_runtime_api::client::interceptors::context::Input,
252            ::aws_smithy_runtime_api::client::interceptors::context::Output,
253            ::aws_smithy_runtime_api::client::interceptors::context::Error,
254        >,
255        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
256    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
257        let _input = context
258            .input()
259            .downcast_ref::<DescribeKeyRegistrationInput>()
260            .ok_or("failed to downcast to DescribeKeyRegistrationInput")?;
261
262        let params = crate::config::endpoint::Params::builder()
263            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
264            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
265            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
266            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
267            .build()
268            .map_err(|err| {
269                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
270            })?;
271        cfg.interceptor_state()
272            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
273        ::std::result::Result::Ok(())
274    }
275}
276
277// The get_* functions below are generated from JMESPath expressions in the
278// operationContextParams trait. They target the operation's input shape.
279
280/// Error type for the `DescribeKeyRegistrationError` operation.
281#[non_exhaustive]
282#[derive(::std::fmt::Debug)]
283pub enum DescribeKeyRegistrationError {
284    /// <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
285    AccessDeniedException(crate::types::error::AccessDeniedException),
286    /// <p>An internal failure occurred.</p>
287    InternalFailureException(crate::types::error::InternalFailureException),
288    /// <p>One or more parameters has a value that isn't valid.</p>
289    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
290    /// <p>Access is throttled.</p>
291    ThrottlingException(crate::types::error::ThrottlingException),
292    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
293    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
294    variable wildcard pattern and check `.code()`:
295     \
296    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
297     \
298    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeKeyRegistrationError) for what information is available for the error.")]
299    Unhandled(crate::error::sealed_unhandled::Unhandled),
300}
301impl DescribeKeyRegistrationError {
302    /// Creates the `DescribeKeyRegistrationError::Unhandled` variant from any error type.
303    pub fn unhandled(
304        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
305    ) -> Self {
306        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
307            source: err.into(),
308            meta: ::std::default::Default::default(),
309        })
310    }
311
312    /// Creates the `DescribeKeyRegistrationError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
313    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
314        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
315            source: err.clone().into(),
316            meta: err,
317        })
318    }
319    ///
320    /// Returns error metadata, which includes the error code, message,
321    /// request ID, and potentially additional information.
322    ///
323    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
324        match self {
325            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::Unhandled(e) => &e.meta,
330        }
331    }
332    /// Returns `true` if the error kind is `DescribeKeyRegistrationError::AccessDeniedException`.
333    pub fn is_access_denied_exception(&self) -> bool {
334        matches!(self, Self::AccessDeniedException(_))
335    }
336    /// Returns `true` if the error kind is `DescribeKeyRegistrationError::InternalFailureException`.
337    pub fn is_internal_failure_exception(&self) -> bool {
338        matches!(self, Self::InternalFailureException(_))
339    }
340    /// Returns `true` if the error kind is `DescribeKeyRegistrationError::InvalidParameterValueException`.
341    pub fn is_invalid_parameter_value_exception(&self) -> bool {
342        matches!(self, Self::InvalidParameterValueException(_))
343    }
344    /// Returns `true` if the error kind is `DescribeKeyRegistrationError::ThrottlingException`.
345    pub fn is_throttling_exception(&self) -> bool {
346        matches!(self, Self::ThrottlingException(_))
347    }
348}
349impl ::std::error::Error for DescribeKeyRegistrationError {
350    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
351        match self {
352            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
353            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
354            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
356            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
357        }
358    }
359}
360impl ::std::fmt::Display for DescribeKeyRegistrationError {
361    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
362        match self {
363            Self::AccessDeniedException(_inner) => _inner.fmt(f),
364            Self::InternalFailureException(_inner) => _inner.fmt(f),
365            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
366            Self::ThrottlingException(_inner) => _inner.fmt(f),
367            Self::Unhandled(_inner) => {
368                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
369                    write!(f, "unhandled error ({code})")
370                } else {
371                    f.write_str("unhandled error")
372                }
373            }
374        }
375    }
376}
377impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeKeyRegistrationError {
378    fn code(&self) -> ::std::option::Option<&str> {
379        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
380    }
381    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
382        ::std::option::Option::None
383    }
384}
385impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeKeyRegistrationError {
386    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
387        match self {
388            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::Unhandled(_inner) => &_inner.meta,
393        }
394    }
395}
396impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeKeyRegistrationError {
397    fn create_unhandled_error(
398        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
399        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
400    ) -> Self {
401        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
402            source,
403            meta: meta.unwrap_or_default(),
404        })
405    }
406}
407impl ::aws_types::request_id::RequestId for crate::operation::describe_key_registration::DescribeKeyRegistrationError {
408    fn request_id(&self) -> Option<&str> {
409        self.meta().request_id()
410    }
411}
412
413pub use crate::operation::describe_key_registration::_describe_key_registration_output::DescribeKeyRegistrationOutput;
414
415pub use crate::operation::describe_key_registration::_describe_key_registration_input::DescribeKeyRegistrationInput;
416
417mod _describe_key_registration_input;
418
419mod _describe_key_registration_output;
420
421/// Builders
422pub mod builders;