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

aws_sdk_quicksight/operation/
list_folders.rs
