aws_sdk_quicksight/operation/
describe_folder.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeFolder`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeFolder;
6impl DescribeFolder {
7    /// Creates a new `DescribeFolder`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::describe_folder::DescribeFolderInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_folder::DescribeFolderOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_folder::DescribeFolderError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::describe_folder::DescribeFolderError>()
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.DescribeFolder",
36                "rpc.service" = "quicksight",
37                "rpc.method" = "DescribeFolder",
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::describe_folder::DescribeFolderOutput>()
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::describe_folder::DescribeFolderInput,
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", "DescribeFolder", 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 DescribeFolder {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeFolder");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            DescribeFolderRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            DescribeFolderResponseDeserializer,
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(
104            "DescribeFolder",
105            "quicksight",
106        ));
107        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
108        signing_options.double_uri_encode = true;
109        signing_options.content_sha256_header = false;
110        signing_options.normalize_uri_path = true;
111        signing_options.payload_override = None;
112
113        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
114            signing_options,
115            ..::std::default::Default::default()
116        });
117
118        ::std::option::Option::Some(cfg.freeze())
119    }
120
121    fn runtime_components(
122        &self,
123        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
124    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
125        #[allow(unused_mut)]
126        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeFolder")
127            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(DescribeFolderEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::describe_folder::DescribeFolderError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::describe_folder::DescribeFolderError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::describe_folder::DescribeFolderError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct DescribeFolderResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeFolderResponseDeserializer {
146    fn deserialize_nonstreaming(
147        &self,
148        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
149    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
150        let (success, status) = (response.status().is_success(), response.status().as_u16());
151        let headers = response.headers();
152        let body = response.body().bytes().expect("body loaded");
153        #[allow(unused_mut)]
154        let mut force_error = false;
155        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
156        let parse_result = if !success && status != 200 || force_error {
157            crate::protocol_serde::shape_describe_folder::de_describe_folder_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_describe_folder::de_describe_folder_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct DescribeFolderRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeFolderRequestSerializer {
167    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
168    fn serialize_input(
169        &self,
170        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
171        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
172    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
173        let input = input
174            .downcast::<crate::operation::describe_folder::DescribeFolderInput>()
175            .expect("correct type");
176        let _header_serialization_settings = _cfg
177            .load::<crate::serialization_settings::HeaderSerializationSettings>()
178            .cloned()
179            .unwrap_or_default();
180        let mut request_builder = {
181            fn uri_base(
182                _input: &crate::operation::describe_folder::DescribeFolderInput,
183                output: &mut ::std::string::String,
184            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
185                use ::std::fmt::Write as _;
186                let input_1 = &_input.aws_account_id;
187                let input_1 = input_1
188                    .as_ref()
189                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
190                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
191                if aws_account_id.is_empty() {
192                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
193                        "aws_account_id",
194                        "cannot be empty or unset",
195                    ));
196                }
197                let input_2 = &_input.folder_id;
198                let input_2 = input_2
199                    .as_ref()
200                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("folder_id", "cannot be empty or unset"))?;
201                let folder_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
202                if folder_id.is_empty() {
203                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
204                        "folder_id",
205                        "cannot be empty or unset",
206                    ));
207                }
208                ::std::write!(
209                    output,
210                    "/accounts/{AwsAccountId}/folders/{FolderId}",
211                    AwsAccountId = aws_account_id,
212                    FolderId = folder_id
213                )
214                .expect("formatting should succeed");
215                ::std::result::Result::Ok(())
216            }
217            #[allow(clippy::unnecessary_wraps)]
218            fn update_http_builder(
219                input: &crate::operation::describe_folder::DescribeFolderInput,
220                builder: ::http::request::Builder,
221            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
222                let mut uri = ::std::string::String::new();
223                uri_base(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 DescribeFolderEndpointParamsInterceptor;
236
237impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeFolderEndpointParamsInterceptor {
238    fn name(&self) -> &'static str {
239        "DescribeFolderEndpointParamsInterceptor"
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::<DescribeFolderInput>()
255            .ok_or("failed to downcast to DescribeFolderInput")?;
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 `DescribeFolderError` operation.
276#[non_exhaustive]
277#[derive(::std::fmt::Debug)]
278pub enum DescribeFolderError {
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>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-DescribeFolderError) for what information is available for the error.")]
298    Unhandled(crate::error::sealed_unhandled::Unhandled),
299}
300impl DescribeFolderError {
301    /// Creates the `DescribeFolderError::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 `DescribeFolderError::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::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::Unhandled(e) => &e.meta,
331        }
332    }
333    /// Returns `true` if the error kind is `DescribeFolderError::AccessDeniedException`.
334    pub fn is_access_denied_exception(&self) -> bool {
335        matches!(self, Self::AccessDeniedException(_))
336    }
337    /// Returns `true` if the error kind is `DescribeFolderError::InternalFailureException`.
338    pub fn is_internal_failure_exception(&self) -> bool {
339        matches!(self, Self::InternalFailureException(_))
340    }
341    /// Returns `true` if the error kind is `DescribeFolderError::InvalidParameterValueException`.
342    pub fn is_invalid_parameter_value_exception(&self) -> bool {
343        matches!(self, Self::InvalidParameterValueException(_))
344    }
345    /// Returns `true` if the error kind is `DescribeFolderError::ResourceNotFoundException`.
346    pub fn is_resource_not_found_exception(&self) -> bool {
347        matches!(self, Self::ResourceNotFoundException(_))
348    }
349    /// Returns `true` if the error kind is `DescribeFolderError::ThrottlingException`.
350    pub fn is_throttling_exception(&self) -> bool {
351        matches!(self, Self::ThrottlingException(_))
352    }
353    /// Returns `true` if the error kind is `DescribeFolderError::UnsupportedUserEditionException`.
354    pub fn is_unsupported_user_edition_exception(&self) -> bool {
355        matches!(self, Self::UnsupportedUserEditionException(_))
356    }
357}
358impl ::std::error::Error for DescribeFolderError {
359    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
360        match self {
361            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
362            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
363            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
364            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
365            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
366            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
367            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
368        }
369    }
370}
371impl ::std::fmt::Display for DescribeFolderError {
372    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
373        match self {
374            Self::AccessDeniedException(_inner) => _inner.fmt(f),
375            Self::InternalFailureException(_inner) => _inner.fmt(f),
376            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
377            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
378            Self::ThrottlingException(_inner) => _inner.fmt(f),
379            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
380            Self::Unhandled(_inner) => {
381                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
382                    write!(f, "unhandled error ({code})")
383                } else {
384                    f.write_str("unhandled error")
385                }
386            }
387        }
388    }
389}
390impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeFolderError {
391    fn code(&self) -> ::std::option::Option<&str> {
392        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
393    }
394    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
395        ::std::option::Option::None
396    }
397}
398impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeFolderError {
399    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
400        match self {
401            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::Unhandled(_inner) => &_inner.meta,
408        }
409    }
410}
411impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeFolderError {
412    fn create_unhandled_error(
413        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
414        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
415    ) -> Self {
416        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
417            source,
418            meta: meta.unwrap_or_default(),
419        })
420    }
421}
422impl ::aws_types::request_id::RequestId for crate::operation::describe_folder::DescribeFolderError {
423    fn request_id(&self) -> Option<&str> {
424        self.meta().request_id()
425    }
426}
427
428pub use crate::operation::describe_folder::_describe_folder_output::DescribeFolderOutput;
429
430pub use crate::operation::describe_folder::_describe_folder_input::DescribeFolderInput;
431
432mod _describe_folder_input;
433
434mod _describe_folder_output;
435
436/// Builders
437pub mod builders;
aws_sdk_quicksight/operation/describe_folder.rs

aws_sdk_quicksight/operation/
describe_folder.rs
