aws_sdk_quicksight/operation/
list_folders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListFolders`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListFolders;
6impl ListFolders {
7    /// Creates a new `ListFolders`
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_folders::ListFoldersInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_folders::ListFoldersOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_folders::ListFoldersError,
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_folders::ListFoldersError>()
27                    .expect("correct error type")
28            })
29        };
30        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "quicksight.ListFolders",
36                "rpc.service" = "quicksight",
37                "rpc.method" = "ListFolders",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::list_folders::ListFoldersOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::list_folders::ListFoldersInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("quicksight", "ListFolders", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74        ]));
75        if let ::std::option::Option::Some(config_override) = config_override {
76            for plugin in config_override.runtime_plugins.iter().cloned() {
77                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
78            }
79            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
80                config_override,
81                client_config.config.clone(),
82                &client_config.runtime_components,
83            ));
84        }
85        runtime_plugins
86    }
87}
88impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListFolders {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListFolders");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            ListFoldersRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            ListFoldersResponseDeserializer,
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
100            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
101        ));
102
103        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListFolders", "quicksight"));
104        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
105        signing_options.double_uri_encode = true;
106        signing_options.content_sha256_header = false;
107        signing_options.normalize_uri_path = true;
108        signing_options.payload_override = None;
109
110        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
111            signing_options,
112            ..::std::default::Default::default()
113        });
114
115        ::std::option::Option::Some(cfg.freeze())
116    }
117
118    fn runtime_components(
119        &self,
120        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
121    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
122        #[allow(unused_mut)]
123        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListFolders")
124            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
125            .with_interceptor(ListFoldersEndpointParamsInterceptor)
126            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
127                crate::operation::list_folders::ListFoldersError,
128            >::new())
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
130                crate::operation::list_folders::ListFoldersError,
131            >::new())
132            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
133                crate::operation::list_folders::ListFoldersError,
134            >::new());
135
136        ::std::borrow::Cow::Owned(rcb)
137    }
138}
139
140#[derive(Debug)]
141struct ListFoldersResponseDeserializer;
142impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListFoldersResponseDeserializer {
143    fn deserialize_nonstreaming(
144        &self,
145        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
146    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
147        let (success, status) = (response.status().is_success(), response.status().as_u16());
148        let headers = response.headers();
149        let body = response.body().bytes().expect("body loaded");
150        #[allow(unused_mut)]
151        let mut force_error = false;
152        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
153        let parse_result = if !success && status != 200 || force_error {
154            crate::protocol_serde::shape_list_folders::de_list_folders_http_error(status, headers, body)
155        } else {
156            crate::protocol_serde::shape_list_folders::de_list_folders_http_response(status, headers, body)
157        };
158        crate::protocol_serde::type_erase_result(parse_result)
159    }
160}
161#[derive(Debug)]
162struct ListFoldersRequestSerializer;
163impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListFoldersRequestSerializer {
164    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
165    fn serialize_input(
166        &self,
167        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
168        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
169    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
170        let input = input
171            .downcast::<crate::operation::list_folders::ListFoldersInput>()
172            .expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            fn uri_base(
179                _input: &crate::operation::list_folders::ListFoldersInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                let input_1 = &_input.aws_account_id;
184                let input_1 = input_1
185                    .as_ref()
186                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
187                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
188                if aws_account_id.is_empty() {
189                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
190                        "aws_account_id",
191                        "cannot be empty or unset",
192                    ));
193                }
194                ::std::write!(output, "/accounts/{AwsAccountId}/folders", AwsAccountId = aws_account_id).expect("formatting should succeed");
195                ::std::result::Result::Ok(())
196            }
197            fn uri_query(
198                _input: &crate::operation::list_folders::ListFoldersInput,
199                mut output: &mut ::std::string::String,
200            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
201                let mut query = ::aws_smithy_http::query::Writer::new(output);
202                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
203                    {
204                        query.push_kv("next-token", &::aws_smithy_http::query::fmt_string(inner_2));
205                    }
206                }
207                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
208                    {
209                        query.push_kv("max-results", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
210                    }
211                }
212                ::std::result::Result::Ok(())
213            }
214            #[allow(clippy::unnecessary_wraps)]
215            fn update_http_builder(
216                input: &crate::operation::list_folders::ListFoldersInput,
217                builder: ::http::request::Builder,
218            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
219                let mut uri = ::std::string::String::new();
220                uri_base(input, &mut uri)?;
221                uri_query(input, &mut uri)?;
222                ::std::result::Result::Ok(builder.method("GET").uri(uri))
223            }
224            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
225            builder
226        };
227        let body = ::aws_smithy_types::body::SdkBody::from("");
228
229        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
230    }
231}
232#[derive(Debug)]
233struct ListFoldersEndpointParamsInterceptor;
234
235impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListFoldersEndpointParamsInterceptor {
236    fn name(&self) -> &'static str {
237        "ListFoldersEndpointParamsInterceptor"
238    }
239
240    fn read_before_execution(
241        &self,
242        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
243            '_,
244            ::aws_smithy_runtime_api::client::interceptors::context::Input,
245            ::aws_smithy_runtime_api::client::interceptors::context::Output,
246            ::aws_smithy_runtime_api::client::interceptors::context::Error,
247        >,
248        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
249    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
250        let _input = context
251            .input()
252            .downcast_ref::<ListFoldersInput>()
253            .ok_or("failed to downcast to ListFoldersInput")?;
254
255        let params = crate::config::endpoint::Params::builder()
256            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
257            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
258            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
259            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
260            .build()
261            .map_err(|err| {
262                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
263            })?;
264        cfg.interceptor_state()
265            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
266        ::std::result::Result::Ok(())
267    }
268}
269
270// The get_* functions below are generated from JMESPath expressions in the
271// operationContextParams trait. They target the operation's input shape.
272
273/// Error type for the `ListFoldersError` operation.
274#[non_exhaustive]
275#[derive(::std::fmt::Debug)]
276pub enum ListFoldersError {
277    /// <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>
278    AccessDeniedException(crate::types::error::AccessDeniedException),
279    /// <p>An internal failure occurred.</p>
280    InternalFailureException(crate::types::error::InternalFailureException),
281    /// <p>The <code>NextToken</code> value isn't valid.</p>
282    InvalidNextTokenException(crate::types::error::InvalidNextTokenException),
283    /// <p>One or more parameters has a value that isn't valid.</p>
284    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
285    /// <p>One or more resources can't be found.</p>
286    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
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 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>
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-ListFoldersError) for what information is available for the error.")]
298    Unhandled(crate::error::sealed_unhandled::Unhandled),
299}
300impl ListFoldersError {
301    /// Creates the `ListFoldersError::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 `ListFoldersError::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::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::InvalidNextTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::Unhandled(e) => &e.meta,
332        }
333    }
334    /// Returns `true` if the error kind is `ListFoldersError::AccessDeniedException`.
335    pub fn is_access_denied_exception(&self) -> bool {
336        matches!(self, Self::AccessDeniedException(_))
337    }
338    /// Returns `true` if the error kind is `ListFoldersError::InternalFailureException`.
339    pub fn is_internal_failure_exception(&self) -> bool {
340        matches!(self, Self::InternalFailureException(_))
341    }
342    /// Returns `true` if the error kind is `ListFoldersError::InvalidNextTokenException`.
343    pub fn is_invalid_next_token_exception(&self) -> bool {
344        matches!(self, Self::InvalidNextTokenException(_))
345    }
346    /// Returns `true` if the error kind is `ListFoldersError::InvalidParameterValueException`.
347    pub fn is_invalid_parameter_value_exception(&self) -> bool {
348        matches!(self, Self::InvalidParameterValueException(_))
349    }
350    /// Returns `true` if the error kind is `ListFoldersError::ResourceNotFoundException`.
351    pub fn is_resource_not_found_exception(&self) -> bool {
352        matches!(self, Self::ResourceNotFoundException(_))
353    }
354    /// Returns `true` if the error kind is `ListFoldersError::ThrottlingException`.
355    pub fn is_throttling_exception(&self) -> bool {
356        matches!(self, Self::ThrottlingException(_))
357    }
358    /// Returns `true` if the error kind is `ListFoldersError::UnsupportedUserEditionException`.
359    pub fn is_unsupported_user_edition_exception(&self) -> bool {
360        matches!(self, Self::UnsupportedUserEditionException(_))
361    }
362}
363impl ::std::error::Error for ListFoldersError {
364    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
365        match self {
366            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
368            Self::InvalidNextTokenException(_inner) => ::std::option::Option::Some(_inner),
369            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
370            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
371            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
372            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
373            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
374        }
375    }
376}
377impl ::std::fmt::Display for ListFoldersError {
378    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
379        match self {
380            Self::AccessDeniedException(_inner) => _inner.fmt(f),
381            Self::InternalFailureException(_inner) => _inner.fmt(f),
382            Self::InvalidNextTokenException(_inner) => _inner.fmt(f),
383            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
384            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
385            Self::ThrottlingException(_inner) => _inner.fmt(f),
386            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
387            Self::Unhandled(_inner) => {
388                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
389                    write!(f, "unhandled error ({code})")
390                } else {
391                    f.write_str("unhandled error")
392                }
393            }
394        }
395    }
396}
397impl ::aws_smithy_types::retry::ProvideErrorKind for ListFoldersError {
398    fn code(&self) -> ::std::option::Option<&str> {
399        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
400    }
401    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
402        ::std::option::Option::None
403    }
404}
405impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListFoldersError {
406    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
407        match self {
408            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::InvalidNextTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::Unhandled(_inner) => &_inner.meta,
416        }
417    }
418}
419impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListFoldersError {
420    fn create_unhandled_error(
421        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
422        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
423    ) -> Self {
424        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
425            source,
426            meta: meta.unwrap_or_default(),
427        })
428    }
429}
430impl ::aws_types::request_id::RequestId for crate::operation::list_folders::ListFoldersError {
431    fn request_id(&self) -> Option<&str> {
432        self.meta().request_id()
433    }
434}
435
436pub use crate::operation::list_folders::_list_folders_output::ListFoldersOutput;
437
438pub use crate::operation::list_folders::_list_folders_input::ListFoldersInput;
439
440mod _list_folders_input;
441
442mod _list_folders_output;
443
444/// Builders
445pub mod builders;
446
447/// Paginator for this operation
448pub mod paginator;
aws_sdk_quicksight/operation/list_folders.rs

aws_sdk_quicksight/operation/
list_folders.rs
