aws_sdk_quicksight/operation/
list_dashboards.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListDashboards`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListDashboards;
6impl ListDashboards {
7    /// Creates a new `ListDashboards`
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::list_dashboards::ListDashboardsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_dashboards::ListDashboardsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_dashboards::ListDashboardsError,
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::list_dashboards::ListDashboardsError>()
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::list_dashboards::ListDashboardsOutput>()
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::list_dashboards::ListDashboardsInput,
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("QuickSight", "ListDashboards", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "QuickSight.ListDashboards",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "ListDashboards",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListDashboards {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListDashboards");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListDashboardsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListDashboardsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListDashboards")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListDashboards",
107            "QuickSight",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListDashboards")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(ListDashboardsEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::list_dashboards::ListDashboardsError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::list_dashboards::ListDashboardsError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::list_dashboards::ListDashboardsError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct ListDashboardsResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListDashboardsResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_list_dashboards::de_list_dashboards_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_list_dashboards::de_list_dashboards_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct ListDashboardsRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListDashboardsRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::list_dashboards::ListDashboardsInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::list_dashboards::ListDashboardsInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                let input_1 = &_input.aws_account_id;
189                let input_1 = input_1
190                    .as_ref()
191                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
192                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
193                if aws_account_id.is_empty() {
194                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
195                        "aws_account_id",
196                        "cannot be empty or unset",
197                    ));
198                }
199                ::std::write!(output, "/accounts/{AwsAccountId}/dashboards", AwsAccountId = aws_account_id).expect("formatting should succeed");
200                ::std::result::Result::Ok(())
201            }
202            fn uri_query(
203                _input: &crate::operation::list_dashboards::ListDashboardsInput,
204                mut output: &mut ::std::string::String,
205            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
206                let mut query = ::aws_smithy_http::query::Writer::new(output);
207                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
208                    {
209                        query.push_kv("next-token", &::aws_smithy_http::query::fmt_string(inner_2));
210                    }
211                }
212                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
213                    {
214                        query.push_kv("max-results", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
215                    }
216                }
217                ::std::result::Result::Ok(())
218            }
219            #[allow(clippy::unnecessary_wraps)]
220            fn update_http_builder(
221                input: &crate::operation::list_dashboards::ListDashboardsInput,
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 ListDashboardsEndpointParamsInterceptor;
239
240impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListDashboardsEndpointParamsInterceptor {
241    fn name(&self) -> &'static str {
242        "ListDashboardsEndpointParamsInterceptor"
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::<ListDashboardsInput>()
258            .ok_or("failed to downcast to ListDashboardsInput")?;
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 `ListDashboardsError` operation.
279#[non_exhaustive]
280#[derive(::std::fmt::Debug)]
281pub enum ListDashboardsError {
282    /// <p>An internal failure occurred.</p>
283    InternalFailureException(crate::types::error::InternalFailureException),
284    /// <p>The <code>NextToken</code> value isn't valid.</p>
285    InvalidNextTokenException(crate::types::error::InvalidNextTokenException),
286    /// <p>Access is throttled.</p>
287    ThrottlingException(crate::types::error::ThrottlingException),
288    /// <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>
289    UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
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-ListDashboardsError) for what information is available for the error.")]
297    Unhandled(crate::error::sealed_unhandled::Unhandled),
298}
299impl ListDashboardsError {
300    /// Creates the `ListDashboardsError::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 `ListDashboardsError::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::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::InvalidNextTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::UnsupportedUserEditionException(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 `ListDashboardsError::InternalFailureException`.
331    pub fn is_internal_failure_exception(&self) -> bool {
332        matches!(self, Self::InternalFailureException(_))
333    }
334    /// Returns `true` if the error kind is `ListDashboardsError::InvalidNextTokenException`.
335    pub fn is_invalid_next_token_exception(&self) -> bool {
336        matches!(self, Self::InvalidNextTokenException(_))
337    }
338    /// Returns `true` if the error kind is `ListDashboardsError::ThrottlingException`.
339    pub fn is_throttling_exception(&self) -> bool {
340        matches!(self, Self::ThrottlingException(_))
341    }
342    /// Returns `true` if the error kind is `ListDashboardsError::UnsupportedUserEditionException`.
343    pub fn is_unsupported_user_edition_exception(&self) -> bool {
344        matches!(self, Self::UnsupportedUserEditionException(_))
345    }
346}
347impl ::std::error::Error for ListDashboardsError {
348    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
349        match self {
350            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
351            Self::InvalidNextTokenException(_inner) => ::std::option::Option::Some(_inner),
352            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
353            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
354            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
355        }
356    }
357}
358impl ::std::fmt::Display for ListDashboardsError {
359    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
360        match self {
361            Self::InternalFailureException(_inner) => _inner.fmt(f),
362            Self::InvalidNextTokenException(_inner) => _inner.fmt(f),
363            Self::ThrottlingException(_inner) => _inner.fmt(f),
364            Self::UnsupportedUserEditionException(_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 ListDashboardsError {
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 ListDashboardsError {
384    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
385        match self {
386            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
387            Self::InvalidNextTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::UnsupportedUserEditionException(_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 ListDashboardsError {
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::list_dashboards::ListDashboardsError {
406    fn request_id(&self) -> Option<&str> {
407        self.meta().request_id()
408    }
409}
410
411pub use crate::operation::list_dashboards::_list_dashboards_output::ListDashboardsOutput;
412
413pub use crate::operation::list_dashboards::_list_dashboards_input::ListDashboardsInput;
414
415mod _list_dashboards_input;
416
417mod _list_dashboards_output;
418
419/// Builders
420pub mod builders;
421
422/// Paginator for this operation
423pub mod paginator;
aws_sdk_quicksight/operation/list_dashboards.rs

aws_sdk_quicksight/operation/
list_dashboards.rs
