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

aws_sdk_quicksight/operation/
describe_key_registration.rs
