aws_sdk_quicksight/operation/
describe_brand.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeBrand`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeBrand;
6impl DescribeBrand {
7    /// Creates a new `DescribeBrand`
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_brand::DescribeBrandInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_brand::DescribeBrandOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_brand::DescribeBrandError,
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_brand::DescribeBrandError>()
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_brand::DescribeBrandOutput>()
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_brand::DescribeBrandInput,
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", "DescribeBrand", 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.DescribeBrand",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "DescribeBrand",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeBrand {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeBrand");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            DescribeBrandRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            DescribeBrandResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
105            "DescribeBrand",
106            "QuickSight",
107        ));
108        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
109        signing_options.double_uri_encode = true;
110        signing_options.content_sha256_header = false;
111        signing_options.normalize_uri_path = true;
112        signing_options.payload_override = None;
113
114        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
115            signing_options,
116            ..::std::default::Default::default()
117        });
118
119        ::std::option::Option::Some(cfg.freeze())
120    }
121
122    fn runtime_components(
123        &self,
124        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
125    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
126        #[allow(unused_mut)]
127        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeBrand")
128            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
129            .with_interceptor(DescribeBrandEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::describe_brand::DescribeBrandError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::describe_brand::DescribeBrandError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::describe_brand::DescribeBrandError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct DescribeBrandResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeBrandResponseDeserializer {
147    fn deserialize_nonstreaming(
148        &self,
149        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
151        let (success, status) = (response.status().is_success(), response.status().as_u16());
152        let headers = response.headers();
153        let body = response.body().bytes().expect("body loaded");
154        #[allow(unused_mut)]
155        let mut force_error = false;
156        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
157        let parse_result = if !success && status != 200 || force_error {
158            crate::protocol_serde::shape_describe_brand::de_describe_brand_http_error(status, headers, body)
159        } else {
160            crate::protocol_serde::shape_describe_brand::de_describe_brand_http_response(status, headers, body)
161        };
162        crate::protocol_serde::type_erase_result(parse_result)
163    }
164}
165#[derive(Debug)]
166struct DescribeBrandRequestSerializer;
167impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeBrandRequestSerializer {
168    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
169    fn serialize_input(
170        &self,
171        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
172        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
174        let input = input
175            .downcast::<crate::operation::describe_brand::DescribeBrandInput>()
176            .expect("correct type");
177        let _header_serialization_settings = _cfg
178            .load::<crate::serialization_settings::HeaderSerializationSettings>()
179            .cloned()
180            .unwrap_or_default();
181        let mut request_builder = {
182            fn uri_base(
183                _input: &crate::operation::describe_brand::DescribeBrandInput,
184                output: &mut ::std::string::String,
185            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
186                use ::std::fmt::Write as _;
187                let input_1 = &_input.aws_account_id;
188                let input_1 = input_1
189                    .as_ref()
190                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
191                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
192                if aws_account_id.is_empty() {
193                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
194                        "aws_account_id",
195                        "cannot be empty or unset",
196                    ));
197                }
198                let input_2 = &_input.brand_id;
199                let input_2 = input_2
200                    .as_ref()
201                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("brand_id", "cannot be empty or unset"))?;
202                let brand_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
203                if brand_id.is_empty() {
204                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
205                        "brand_id",
206                        "cannot be empty or unset",
207                    ));
208                }
209                ::std::write!(
210                    output,
211                    "/accounts/{AwsAccountId}/brands/{BrandId}",
212                    AwsAccountId = aws_account_id,
213                    BrandId = brand_id
214                )
215                .expect("formatting should succeed");
216                ::std::result::Result::Ok(())
217            }
218            fn uri_query(
219                _input: &crate::operation::describe_brand::DescribeBrandInput,
220                mut output: &mut ::std::string::String,
221            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
222                let mut query = ::aws_smithy_http::query::Writer::new(output);
223                if let ::std::option::Option::Some(inner_3) = &_input.version_id {
224                    {
225                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_3));
226                    }
227                }
228                ::std::result::Result::Ok(())
229            }
230            #[allow(clippy::unnecessary_wraps)]
231            fn update_http_builder(
232                input: &crate::operation::describe_brand::DescribeBrandInput,
233                builder: ::http::request::Builder,
234            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
235                let mut uri = ::std::string::String::new();
236                uri_base(input, &mut uri)?;
237                uri_query(input, &mut uri)?;
238                ::std::result::Result::Ok(builder.method("GET").uri(uri))
239            }
240            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
241            builder
242        };
243        let body = ::aws_smithy_types::body::SdkBody::from("");
244
245        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
246    }
247}
248#[derive(Debug)]
249struct DescribeBrandEndpointParamsInterceptor;
250
251impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeBrandEndpointParamsInterceptor {
252    fn name(&self) -> &'static str {
253        "DescribeBrandEndpointParamsInterceptor"
254    }
255
256    fn read_before_execution(
257        &self,
258        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
259            '_,
260            ::aws_smithy_runtime_api::client::interceptors::context::Input,
261            ::aws_smithy_runtime_api::client::interceptors::context::Output,
262            ::aws_smithy_runtime_api::client::interceptors::context::Error,
263        >,
264        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
265    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
266        let _input = context
267            .input()
268            .downcast_ref::<DescribeBrandInput>()
269            .ok_or("failed to downcast to DescribeBrandInput")?;
270
271        let params = crate::config::endpoint::Params::builder()
272            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
273            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
274            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
275            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
276            .build()
277            .map_err(|err| {
278                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
279            })?;
280        cfg.interceptor_state()
281            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
282        ::std::result::Result::Ok(())
283    }
284}
285
286// The get_* functions below are generated from JMESPath expressions in the
287// operationContextParams trait. They target the operation's input shape.
288
289/// Error type for the `DescribeBrandError` operation.
290#[non_exhaustive]
291#[derive(::std::fmt::Debug)]
292pub enum DescribeBrandError {
293    /// <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>
294    AccessDeniedException(crate::types::error::AccessDeniedException),
295    /// <p>Updating or deleting a resource can cause an inconsistent state.</p>
296    ConflictException(crate::types::error::ConflictException),
297    /// <p>An internal service exception.</p>
298    InternalServerException(crate::types::error::InternalServerException),
299    /// <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
300    InvalidRequestException(crate::types::error::InvalidRequestException),
301    /// <p>One or more resources can't be found.</p>
302    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
303    /// <p>Access is throttled.</p>
304    ThrottlingException(crate::types::error::ThrottlingException),
305    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
306    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
307    variable wildcard pattern and check `.code()`:
308     \
309    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
310     \
311    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeBrandError) for what information is available for the error.")]
312    Unhandled(crate::error::sealed_unhandled::Unhandled),
313}
314impl DescribeBrandError {
315    /// Creates the `DescribeBrandError::Unhandled` variant from any error type.
316    pub fn unhandled(
317        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
318    ) -> Self {
319        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
320            source: err.into(),
321            meta: ::std::default::Default::default(),
322        })
323    }
324
325    /// Creates the `DescribeBrandError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
326    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
327        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
328            source: err.clone().into(),
329            meta: err,
330        })
331    }
332    ///
333    /// Returns error metadata, which includes the error code, message,
334    /// request ID, and potentially additional information.
335    ///
336    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
337        match self {
338            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
341            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
342            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
343            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
344            Self::Unhandled(e) => &e.meta,
345        }
346    }
347    /// Returns `true` if the error kind is `DescribeBrandError::AccessDeniedException`.
348    pub fn is_access_denied_exception(&self) -> bool {
349        matches!(self, Self::AccessDeniedException(_))
350    }
351    /// Returns `true` if the error kind is `DescribeBrandError::ConflictException`.
352    pub fn is_conflict_exception(&self) -> bool {
353        matches!(self, Self::ConflictException(_))
354    }
355    /// Returns `true` if the error kind is `DescribeBrandError::InternalServerException`.
356    pub fn is_internal_server_exception(&self) -> bool {
357        matches!(self, Self::InternalServerException(_))
358    }
359    /// Returns `true` if the error kind is `DescribeBrandError::InvalidRequestException`.
360    pub fn is_invalid_request_exception(&self) -> bool {
361        matches!(self, Self::InvalidRequestException(_))
362    }
363    /// Returns `true` if the error kind is `DescribeBrandError::ResourceNotFoundException`.
364    pub fn is_resource_not_found_exception(&self) -> bool {
365        matches!(self, Self::ResourceNotFoundException(_))
366    }
367    /// Returns `true` if the error kind is `DescribeBrandError::ThrottlingException`.
368    pub fn is_throttling_exception(&self) -> bool {
369        matches!(self, Self::ThrottlingException(_))
370    }
371}
372impl ::std::error::Error for DescribeBrandError {
373    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
374        match self {
375            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
376            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
377            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
378            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
379            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
381            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
382        }
383    }
384}
385impl ::std::fmt::Display for DescribeBrandError {
386    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
387        match self {
388            Self::AccessDeniedException(_inner) => _inner.fmt(f),
389            Self::ConflictException(_inner) => _inner.fmt(f),
390            Self::InternalServerException(_inner) => _inner.fmt(f),
391            Self::InvalidRequestException(_inner) => _inner.fmt(f),
392            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
393            Self::ThrottlingException(_inner) => _inner.fmt(f),
394            Self::Unhandled(_inner) => {
395                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
396                    write!(f, "unhandled error ({code})")
397                } else {
398                    f.write_str("unhandled error")
399                }
400            }
401        }
402    }
403}
404impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeBrandError {
405    fn code(&self) -> ::std::option::Option<&str> {
406        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
407    }
408    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
409        ::std::option::Option::None
410    }
411}
412impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeBrandError {
413    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
414        match self {
415            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::Unhandled(_inner) => &_inner.meta,
422        }
423    }
424}
425impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeBrandError {
426    fn create_unhandled_error(
427        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
428        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
429    ) -> Self {
430        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
431            source,
432            meta: meta.unwrap_or_default(),
433        })
434    }
435}
436impl ::aws_types::request_id::RequestId for crate::operation::describe_brand::DescribeBrandError {
437    fn request_id(&self) -> Option<&str> {
438        self.meta().request_id()
439    }
440}
441
442pub use crate::operation::describe_brand::_describe_brand_output::DescribeBrandOutput;
443
444pub use crate::operation::describe_brand::_describe_brand_input::DescribeBrandInput;
445
446mod _describe_brand_input;
447
448mod _describe_brand_output;
449
450/// Builders
451pub mod builders;