aws_sdk_quicksight/operation/
describe_dashboard.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeDashboard`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeDashboard;
6impl DescribeDashboard {
7    /// Creates a new `DescribeDashboard`
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_dashboard::DescribeDashboardInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_dashboard::DescribeDashboardOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_dashboard::DescribeDashboardError,
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_dashboard::DescribeDashboardError>()
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_dashboard::DescribeDashboardOutput>()
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_dashboard::DescribeDashboardInput,
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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("quicksight", "DescribeDashboard", input, runtime_plugins, stop_point)
54            .await
55    }
56
57    pub(crate) fn operation_runtime_plugins(
58        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
59        client_config: &crate::config::Config,
60        config_override: ::std::option::Option<crate::config::Builder>,
61    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
62        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
63        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
64            ::aws_runtime::auth::sigv4::SCHEME_ID,
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 DescribeDashboard {
80    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeDashboard");
82
83        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84            DescribeDashboardRequestSerializer,
85        ));
86        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87            DescribeDashboardResponseDeserializer,
88        ));
89
90        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
95        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
96            "DescribeDashboard",
97            "quicksight",
98        ));
99        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
100        signing_options.double_uri_encode = true;
101        signing_options.content_sha256_header = false;
102        signing_options.normalize_uri_path = true;
103        signing_options.payload_override = None;
104
105        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
106            signing_options,
107            ..::std::default::Default::default()
108        });
109
110        ::std::option::Option::Some(cfg.freeze())
111    }
112
113    fn runtime_components(
114        &self,
115        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
116    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
117        #[allow(unused_mut)]
118        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeDashboard")
119            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
120            .with_interceptor(DescribeDashboardEndpointParamsInterceptor)
121            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
122                crate::operation::describe_dashboard::DescribeDashboardError,
123            >::new())
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
125                crate::operation::describe_dashboard::DescribeDashboardError,
126            >::new())
127            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
128                crate::operation::describe_dashboard::DescribeDashboardError,
129            >::new());
130
131        ::std::borrow::Cow::Owned(rcb)
132    }
133}
134
135#[derive(Debug)]
136struct DescribeDashboardResponseDeserializer;
137impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeDashboardResponseDeserializer {
138    fn deserialize_nonstreaming(
139        &self,
140        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
141    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
142        let (success, status) = (response.status().is_success(), response.status().as_u16());
143        let headers = response.headers();
144        let body = response.body().bytes().expect("body loaded");
145        #[allow(unused_mut)]
146        let mut force_error = false;
147        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
148        let parse_result = if !success && status != 200 || force_error {
149            crate::protocol_serde::shape_describe_dashboard::de_describe_dashboard_http_error(status, headers, body)
150        } else {
151            crate::protocol_serde::shape_describe_dashboard::de_describe_dashboard_http_response(status, headers, body)
152        };
153        crate::protocol_serde::type_erase_result(parse_result)
154    }
155}
156#[derive(Debug)]
157struct DescribeDashboardRequestSerializer;
158impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeDashboardRequestSerializer {
159    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
160    fn serialize_input(
161        &self,
162        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
163        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
164    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
165        let input = input
166            .downcast::<crate::operation::describe_dashboard::DescribeDashboardInput>()
167            .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            fn uri_base(
174                _input: &crate::operation::describe_dashboard::DescribeDashboardInput,
175                output: &mut ::std::string::String,
176            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
177                use ::std::fmt::Write as _;
178                let input_1 = &_input.aws_account_id;
179                let input_1 = input_1
180                    .as_ref()
181                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
182                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
183                if aws_account_id.is_empty() {
184                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
185                        "aws_account_id",
186                        "cannot be empty or unset",
187                    ));
188                }
189                let input_2 = &_input.dashboard_id;
190                let input_2 = input_2
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("dashboard_id", "cannot be empty or unset"))?;
193                let dashboard_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if dashboard_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "dashboard_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(
201                    output,
202                    "/accounts/{AwsAccountId}/dashboards/{DashboardId}",
203                    AwsAccountId = aws_account_id,
204                    DashboardId = dashboard_id
205                )
206                .expect("formatting should succeed");
207                ::std::result::Result::Ok(())
208            }
209            fn uri_query(
210                _input: &crate::operation::describe_dashboard::DescribeDashboardInput,
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_3) = &_input.version_number {
215                    {
216                        query.push_kv("version-number", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
217                    }
218                }
219                if let ::std::option::Option::Some(inner_4) = &_input.alias_name {
220                    {
221                        query.push_kv("alias-name", &::aws_smithy_http::query::fmt_string(inner_4));
222                    }
223                }
224                ::std::result::Result::Ok(())
225            }
226            #[allow(clippy::unnecessary_wraps)]
227            fn update_http_builder(
228                input: &crate::operation::describe_dashboard::DescribeDashboardInput,
229                builder: ::http::request::Builder,
230            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
231                let mut uri = ::std::string::String::new();
232                uri_base(input, &mut uri)?;
233                uri_query(input, &mut uri)?;
234                ::std::result::Result::Ok(builder.method("GET").uri(uri))
235            }
236            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
237            builder
238        };
239        let body = ::aws_smithy_types::body::SdkBody::from("");
240
241        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
242    }
243}
244#[derive(Debug)]
245struct DescribeDashboardEndpointParamsInterceptor;
246
247impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeDashboardEndpointParamsInterceptor {
248    fn name(&self) -> &'static str {
249        "DescribeDashboardEndpointParamsInterceptor"
250    }
251
252    fn read_before_execution(
253        &self,
254        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
255            '_,
256            ::aws_smithy_runtime_api::client::interceptors::context::Input,
257            ::aws_smithy_runtime_api::client::interceptors::context::Output,
258            ::aws_smithy_runtime_api::client::interceptors::context::Error,
259        >,
260        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
261    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
262        let _input = context
263            .input()
264            .downcast_ref::<DescribeDashboardInput>()
265            .ok_or("failed to downcast to DescribeDashboardInput")?;
266
267        let params = crate::config::endpoint::Params::builder()
268            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
269            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
270            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
271            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
272            .build()
273            .map_err(|err| {
274                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
275            })?;
276        cfg.interceptor_state()
277            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
278        ::std::result::Result::Ok(())
279    }
280}
281
282// The get_* functions below are generated from JMESPath expressions in the
283// operationContextParams trait. They target the operation's input shape.
284
285/// Error type for the `DescribeDashboardError` operation.
286#[non_exhaustive]
287#[derive(::std::fmt::Debug)]
288pub enum DescribeDashboardError {
289    /// <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>
290    AccessDeniedException(crate::types::error::AccessDeniedException),
291    /// <p>An internal failure occurred.</p>
292    InternalFailureException(crate::types::error::InternalFailureException),
293    /// <p>One or more parameters has a value that isn't valid.</p>
294    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
295    /// <p>One or more resources can't be found.</p>
296    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
297    /// <p>Access is throttled.</p>
298    ThrottlingException(crate::types::error::ThrottlingException),
299    /// <p>This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
300    UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
301    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
302    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
303    variable wildcard pattern and check `.code()`:
304     \
305    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
306     \
307    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeDashboardError) for what information is available for the error.")]
308    Unhandled(crate::error::sealed_unhandled::Unhandled),
309}
310impl DescribeDashboardError {
311    /// Creates the `DescribeDashboardError::Unhandled` variant from any error type.
312    pub fn unhandled(
313        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
314    ) -> Self {
315        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
316            source: err.into(),
317            meta: ::std::default::Default::default(),
318        })
319    }
320
321    /// Creates the `DescribeDashboardError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
322    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
323        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
324            source: err.clone().into(),
325            meta: err,
326        })
327    }
328    ///
329    /// Returns error metadata, which includes the error code, message,
330    /// request ID, and potentially additional information.
331    ///
332    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
333        match self {
334            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::Unhandled(e) => &e.meta,
341        }
342    }
343    /// Returns `true` if the error kind is `DescribeDashboardError::AccessDeniedException`.
344    pub fn is_access_denied_exception(&self) -> bool {
345        matches!(self, Self::AccessDeniedException(_))
346    }
347    /// Returns `true` if the error kind is `DescribeDashboardError::InternalFailureException`.
348    pub fn is_internal_failure_exception(&self) -> bool {
349        matches!(self, Self::InternalFailureException(_))
350    }
351    /// Returns `true` if the error kind is `DescribeDashboardError::InvalidParameterValueException`.
352    pub fn is_invalid_parameter_value_exception(&self) -> bool {
353        matches!(self, Self::InvalidParameterValueException(_))
354    }
355    /// Returns `true` if the error kind is `DescribeDashboardError::ResourceNotFoundException`.
356    pub fn is_resource_not_found_exception(&self) -> bool {
357        matches!(self, Self::ResourceNotFoundException(_))
358    }
359    /// Returns `true` if the error kind is `DescribeDashboardError::ThrottlingException`.
360    pub fn is_throttling_exception(&self) -> bool {
361        matches!(self, Self::ThrottlingException(_))
362    }
363    /// Returns `true` if the error kind is `DescribeDashboardError::UnsupportedUserEditionException`.
364    pub fn is_unsupported_user_edition_exception(&self) -> bool {
365        matches!(self, Self::UnsupportedUserEditionException(_))
366    }
367}
368impl ::std::error::Error for DescribeDashboardError {
369    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
370        match self {
371            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
372            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
373            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
374            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
375            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
376            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
377            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
378        }
379    }
380}
381impl ::std::fmt::Display for DescribeDashboardError {
382    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
383        match self {
384            Self::AccessDeniedException(_inner) => _inner.fmt(f),
385            Self::InternalFailureException(_inner) => _inner.fmt(f),
386            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
387            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
388            Self::ThrottlingException(_inner) => _inner.fmt(f),
389            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
390            Self::Unhandled(_inner) => {
391                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
392                    write!(f, "unhandled error ({code})")
393                } else {
394                    f.write_str("unhandled error")
395                }
396            }
397        }
398    }
399}
400impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeDashboardError {
401    fn code(&self) -> ::std::option::Option<&str> {
402        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
403    }
404    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
405        ::std::option::Option::None
406    }
407}
408impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeDashboardError {
409    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
410        match self {
411            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::Unhandled(_inner) => &_inner.meta,
418        }
419    }
420}
421impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeDashboardError {
422    fn create_unhandled_error(
423        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
424        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
425    ) -> Self {
426        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
427            source,
428            meta: meta.unwrap_or_default(),
429        })
430    }
431}
432impl ::aws_types::request_id::RequestId for crate::operation::describe_dashboard::DescribeDashboardError {
433    fn request_id(&self) -> Option<&str> {
434        self.meta().request_id()
435    }
436}
437
438pub use crate::operation::describe_dashboard::_describe_dashboard_output::DescribeDashboardOutput;
439
440pub use crate::operation::describe_dashboard::_describe_dashboard_input::DescribeDashboardInput;
441
442mod _describe_dashboard_input;
443
444mod _describe_dashboard_output;
445
446/// Builders
447pub mod builders;
aws_sdk_quicksight/operation/describe_dashboard.rs

aws_sdk_quicksight/operation/
describe_dashboard.rs
