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            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::list_dashboards::ListDashboardsInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.aws_account_id;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
193                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if aws_account_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "aws_account_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/accounts/{AwsAccountId}/dashboards", AwsAccountId = aws_account_id).expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            fn uri_query(
204                _input: &crate::operation::list_dashboards::ListDashboardsInput,
205                mut output: &mut ::std::string::String,
206            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
207                let mut query = ::aws_smithy_http::query::Writer::new(output);
208                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
209                    {
210                        query.push_kv("next-token", &::aws_smithy_http::query::fmt_string(inner_2));
211                    }
212                }
213                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
214                    {
215                        query.push_kv("max-results", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
216                    }
217                }
218                ::std::result::Result::Ok(())
219            }
220            #[allow(clippy::unnecessary_wraps)]
221            fn update_http_builder(
222                input: &crate::operation::list_dashboards::ListDashboardsInput,
223                builder: ::http::request::Builder,
224            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
225                let mut uri = ::std::string::String::new();
226                uri_base(input, &mut uri)?;
227                uri_query(input, &mut uri)?;
228                ::std::result::Result::Ok(builder.method("GET").uri(uri))
229            }
230            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
231            builder
232        };
233        let body = ::aws_smithy_types::body::SdkBody::from("");
234
235        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
236    }
237}
238#[derive(Debug)]
239struct ListDashboardsEndpointParamsInterceptor;
240
241impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListDashboardsEndpointParamsInterceptor {
242    fn name(&self) -> &'static str {
243        "ListDashboardsEndpointParamsInterceptor"
244    }
245
246    fn read_before_execution(
247        &self,
248        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
249            '_,
250            ::aws_smithy_runtime_api::client::interceptors::context::Input,
251            ::aws_smithy_runtime_api::client::interceptors::context::Output,
252            ::aws_smithy_runtime_api::client::interceptors::context::Error,
253        >,
254        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
255    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
256        let _input = context
257            .input()
258            .downcast_ref::<ListDashboardsInput>()
259            .ok_or("failed to downcast to ListDashboardsInput")?;
260
261        let params = crate::config::endpoint::Params::builder()
262            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
263            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
264            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
265            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
266            .build()
267            .map_err(|err| {
268                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
269            })?;
270        cfg.interceptor_state()
271            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
272        ::std::result::Result::Ok(())
273    }
274}
275
276// The get_* functions below are generated from JMESPath expressions in the
277// operationContextParams trait. They target the operation's input shape.
278
279/// Error type for the `ListDashboardsError` operation.
280#[non_exhaustive]
281#[derive(::std::fmt::Debug)]
282pub enum ListDashboardsError {
283    /// <p>An internal failure occurred.</p>
284    InternalFailureException(crate::types::error::InternalFailureException),
285    /// <p>The <code>NextToken</code> value isn't valid.</p>
286    InvalidNextTokenException(crate::types::error::InvalidNextTokenException),
287    /// <p>Access is throttled.</p>
288    ThrottlingException(crate::types::error::ThrottlingException),
289    /// <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
290    UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
291    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
292    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
293    variable wildcard pattern and check `.code()`:
294     \
295    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
296     \
297    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListDashboardsError) for what information is available for the error.")]
298    Unhandled(crate::error::sealed_unhandled::Unhandled),
299}
300impl ListDashboardsError {
301    /// Creates the `ListDashboardsError::Unhandled` variant from any error type.
302    pub fn unhandled(
303        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
304    ) -> Self {
305        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
306            source: err.into(),
307            meta: ::std::default::Default::default(),
308        })
309    }
310
311    /// Creates the `ListDashboardsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
312    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
313        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
314            source: err.clone().into(),
315            meta: err,
316        })
317    }
318    ///
319    /// Returns error metadata, which includes the error code, message,
320    /// request ID, and potentially additional information.
321    ///
322    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
323        match self {
324            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::InvalidNextTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::Unhandled(e) => &e.meta,
329        }
330    }
331    /// Returns `true` if the error kind is `ListDashboardsError::InternalFailureException`.
332    pub fn is_internal_failure_exception(&self) -> bool {
333        matches!(self, Self::InternalFailureException(_))
334    }
335    /// Returns `true` if the error kind is `ListDashboardsError::InvalidNextTokenException`.
336    pub fn is_invalid_next_token_exception(&self) -> bool {
337        matches!(self, Self::InvalidNextTokenException(_))
338    }
339    /// Returns `true` if the error kind is `ListDashboardsError::ThrottlingException`.
340    pub fn is_throttling_exception(&self) -> bool {
341        matches!(self, Self::ThrottlingException(_))
342    }
343    /// Returns `true` if the error kind is `ListDashboardsError::UnsupportedUserEditionException`.
344    pub fn is_unsupported_user_edition_exception(&self) -> bool {
345        matches!(self, Self::UnsupportedUserEditionException(_))
346    }
347}
348impl ::std::error::Error for ListDashboardsError {
349    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
350        match self {
351            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
352            Self::InvalidNextTokenException(_inner) => ::std::option::Option::Some(_inner),
353            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
354            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
355            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
356        }
357    }
358}
359impl ::std::fmt::Display for ListDashboardsError {
360    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
361        match self {
362            Self::InternalFailureException(_inner) => _inner.fmt(f),
363            Self::InvalidNextTokenException(_inner) => _inner.fmt(f),
364            Self::ThrottlingException(_inner) => _inner.fmt(f),
365            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
366            Self::Unhandled(_inner) => {
367                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
368                    write!(f, "unhandled error ({code})")
369                } else {
370                    f.write_str("unhandled error")
371                }
372            }
373        }
374    }
375}
376impl ::aws_smithy_types::retry::ProvideErrorKind for ListDashboardsError {
377    fn code(&self) -> ::std::option::Option<&str> {
378        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
379    }
380    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
381        ::std::option::Option::None
382    }
383}
384impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListDashboardsError {
385    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
386        match self {
387            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::InvalidNextTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::Unhandled(_inner) => &_inner.meta,
392        }
393    }
394}
395impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListDashboardsError {
396    fn create_unhandled_error(
397        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
398        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
399    ) -> Self {
400        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
401            source,
402            meta: meta.unwrap_or_default(),
403        })
404    }
405}
406impl ::aws_types::request_id::RequestId for crate::operation::list_dashboards::ListDashboardsError {
407    fn request_id(&self) -> Option<&str> {
408        self.meta().request_id()
409    }
410}
411
412pub use crate::operation::list_dashboards::_list_dashboards_output::ListDashboardsOutput;
413
414pub use crate::operation::list_dashboards::_list_dashboards_input::ListDashboardsInput;
415
416mod _list_dashboards_input;
417
418mod _list_dashboards_output;
419
420/// Builders
421pub mod builders;
422
423/// Paginator for this operation
424pub mod paginator;
aws_sdk_quicksight/operation/list_dashboards.rs

aws_sdk_quicksight/operation/
list_dashboards.rs
