aws_sdk_quicksight/operation/
describe_analysis.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeAnalysis`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeAnalysis;
6impl DescribeAnalysis {
7    /// Creates a new `DescribeAnalysis`
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_analysis::DescribeAnalysisInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_analysis::DescribeAnalysisOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_analysis::DescribeAnalysisError,
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_analysis::DescribeAnalysisError>()
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::describe_analysis::DescribeAnalysisOutput>()
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::describe_analysis::DescribeAnalysisInput,
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", "DescribeAnalysis", 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.DescribeAnalysis",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "DescribeAnalysis",
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 DescribeAnalysis {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeAnalysis");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeAnalysisRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeAnalysisResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeAnalysis")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
107            "DescribeAnalysis",
108            "QuickSight",
109        ));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = true;
112        signing_options.content_sha256_header = false;
113        signing_options.normalize_uri_path = true;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeAnalysis")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(DescribeAnalysisEndpointParamsInterceptor)
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::describe_analysis::DescribeAnalysisError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::describe_analysis::DescribeAnalysisError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::describe_analysis::DescribeAnalysisError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct DescribeAnalysisResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeAnalysisResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 200 || force_error {
160            crate::protocol_serde::shape_describe_analysis::de_describe_analysis_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_describe_analysis::de_describe_analysis_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct DescribeAnalysisRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeAnalysisRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::describe_analysis::DescribeAnalysisInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            #[allow(clippy::uninlined_format_args)]
185            fn uri_base(
186                _input: &crate::operation::describe_analysis::DescribeAnalysisInput,
187                output: &mut ::std::string::String,
188            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
189                use ::std::fmt::Write as _;
190                let input_1 = &_input.aws_account_id;
191                let input_1 = input_1
192                    .as_ref()
193                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
194                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
195                if aws_account_id.is_empty() {
196                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
197                        "aws_account_id",
198                        "cannot be empty or unset",
199                    ));
200                }
201                let input_2 = &_input.analysis_id;
202                let input_2 = input_2
203                    .as_ref()
204                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("analysis_id", "cannot be empty or unset"))?;
205                let analysis_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
206                if analysis_id.is_empty() {
207                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
208                        "analysis_id",
209                        "cannot be empty or unset",
210                    ));
211                }
212                ::std::write!(
213                    output,
214                    "/accounts/{AwsAccountId}/analyses/{AnalysisId}",
215                    AwsAccountId = aws_account_id,
216                    AnalysisId = analysis_id
217                )
218                .expect("formatting should succeed");
219                ::std::result::Result::Ok(())
220            }
221            #[allow(clippy::unnecessary_wraps)]
222            fn update_http_builder(
223                input: &crate::operation::describe_analysis::DescribeAnalysisInput,
224                builder: ::http::request::Builder,
225            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
226                let mut uri = ::std::string::String::new();
227                uri_base(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 DescribeAnalysisEndpointParamsInterceptor;
240
241impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeAnalysisEndpointParamsInterceptor {
242    fn name(&self) -> &'static str {
243        "DescribeAnalysisEndpointParamsInterceptor"
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::<DescribeAnalysisInput>()
259            .ok_or("failed to downcast to DescribeAnalysisInput")?;
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 `DescribeAnalysisError` operation.
280#[non_exhaustive]
281#[derive(::std::fmt::Debug)]
282pub enum DescribeAnalysisError {
283    /// <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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
284    AccessDeniedException(crate::types::error::AccessDeniedException),
285    /// <p>An internal failure occurred.</p>
286    InternalFailureException(crate::types::error::InternalFailureException),
287    /// <p>One or more parameters has a value that isn't valid.</p>
288    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
289    /// <p>One or more resources can't be found.</p>
290    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
291    /// <p>Access is throttled.</p>
292    ThrottlingException(crate::types::error::ThrottlingException),
293    /// <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>
294    UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
295    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
296    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
297    variable wildcard pattern and check `.code()`:
298     \
299    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
300     \
301    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeAnalysisError) for what information is available for the error.")]
302    Unhandled(crate::error::sealed_unhandled::Unhandled),
303}
304impl DescribeAnalysisError {
305    /// Creates the `DescribeAnalysisError::Unhandled` variant from any error type.
306    pub fn unhandled(
307        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
308    ) -> Self {
309        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
310            source: err.into(),
311            meta: ::std::default::Default::default(),
312        })
313    }
314
315    /// Creates the `DescribeAnalysisError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
316    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
317        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
318            source: err.clone().into(),
319            meta: err,
320        })
321    }
322    ///
323    /// Returns error metadata, which includes the error code, message,
324    /// request ID, and potentially additional information.
325    ///
326    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
327        match self {
328            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::Unhandled(e) => &e.meta,
335        }
336    }
337    /// Returns `true` if the error kind is `DescribeAnalysisError::AccessDeniedException`.
338    pub fn is_access_denied_exception(&self) -> bool {
339        matches!(self, Self::AccessDeniedException(_))
340    }
341    /// Returns `true` if the error kind is `DescribeAnalysisError::InternalFailureException`.
342    pub fn is_internal_failure_exception(&self) -> bool {
343        matches!(self, Self::InternalFailureException(_))
344    }
345    /// Returns `true` if the error kind is `DescribeAnalysisError::InvalidParameterValueException`.
346    pub fn is_invalid_parameter_value_exception(&self) -> bool {
347        matches!(self, Self::InvalidParameterValueException(_))
348    }
349    /// Returns `true` if the error kind is `DescribeAnalysisError::ResourceNotFoundException`.
350    pub fn is_resource_not_found_exception(&self) -> bool {
351        matches!(self, Self::ResourceNotFoundException(_))
352    }
353    /// Returns `true` if the error kind is `DescribeAnalysisError::ThrottlingException`.
354    pub fn is_throttling_exception(&self) -> bool {
355        matches!(self, Self::ThrottlingException(_))
356    }
357    /// Returns `true` if the error kind is `DescribeAnalysisError::UnsupportedUserEditionException`.
358    pub fn is_unsupported_user_edition_exception(&self) -> bool {
359        matches!(self, Self::UnsupportedUserEditionException(_))
360    }
361}
362impl ::std::error::Error for DescribeAnalysisError {
363    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
364        match self {
365            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
366            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
368            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
369            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
370            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
371            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
372        }
373    }
374}
375impl ::std::fmt::Display for DescribeAnalysisError {
376    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
377        match self {
378            Self::AccessDeniedException(_inner) => _inner.fmt(f),
379            Self::InternalFailureException(_inner) => _inner.fmt(f),
380            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
381            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
382            Self::ThrottlingException(_inner) => _inner.fmt(f),
383            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
384            Self::Unhandled(_inner) => {
385                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
386                    write!(f, "unhandled error ({code})")
387                } else {
388                    f.write_str("unhandled error")
389                }
390            }
391        }
392    }
393}
394impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeAnalysisError {
395    fn code(&self) -> ::std::option::Option<&str> {
396        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
397    }
398    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
399        ::std::option::Option::None
400    }
401}
402impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeAnalysisError {
403    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
404        match self {
405            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::Unhandled(_inner) => &_inner.meta,
412        }
413    }
414}
415impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeAnalysisError {
416    fn create_unhandled_error(
417        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
418        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
419    ) -> Self {
420        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
421            source,
422            meta: meta.unwrap_or_default(),
423        })
424    }
425}
426impl ::aws_types::request_id::RequestId for crate::operation::describe_analysis::DescribeAnalysisError {
427    fn request_id(&self) -> Option<&str> {
428        self.meta().request_id()
429    }
430}
431
432pub use crate::operation::describe_analysis::_describe_analysis_output::DescribeAnalysisOutput;
433
434pub use crate::operation::describe_analysis::_describe_analysis_input::DescribeAnalysisInput;
435
436mod _describe_analysis_input;
437
438mod _describe_analysis_output;
439
440/// Builders
441pub mod builders;
aws_sdk_quicksight/operation/describe_analysis.rs

aws_sdk_quicksight/operation/
describe_analysis.rs
