aws_sdk_quicksight/operation/
list_brands.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListBrands`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListBrands;
6impl ListBrands {
7    /// Creates a new `ListBrands`
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_brands::ListBrandsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_brands::ListBrandsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_brands::ListBrandsError,
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_brands::ListBrandsError>()
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_brands::ListBrandsOutput>()
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_brands::ListBrandsInput,
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", "ListBrands", 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.ListBrands",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "ListBrands",
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 ListBrands {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListBrands");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListBrandsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListBrandsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListBrands")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListBrands", "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("ListBrands")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(ListBrandsEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::list_brands::ListBrandsError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::list_brands::ListBrandsError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::list_brands::ListBrandsError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct ListBrandsResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListBrandsResponseDeserializer {
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_brands::de_list_brands_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_list_brands::de_list_brands_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct ListBrandsRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListBrandsRequestSerializer {
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.downcast::<crate::operation::list_brands::ListBrandsInput>().expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            fn uri_base(
179                _input: &crate::operation::list_brands::ListBrandsInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                let input_1 = &_input.aws_account_id;
184                let input_1 = input_1
185                    .as_ref()
186                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
187                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
188                if aws_account_id.is_empty() {
189                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
190                        "aws_account_id",
191                        "cannot be empty or unset",
192                    ));
193                }
194                ::std::write!(output, "/accounts/{AwsAccountId}/brands", AwsAccountId = aws_account_id).expect("formatting should succeed");
195                ::std::result::Result::Ok(())
196            }
197            fn uri_query(
198                _input: &crate::operation::list_brands::ListBrandsInput,
199                mut output: &mut ::std::string::String,
200            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
201                let mut query = ::aws_smithy_http::query::Writer::new(output);
202                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
203                    {
204                        query.push_kv("max-results", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
205                    }
206                }
207                if let ::std::option::Option::Some(inner_3) = &_input.next_token {
208                    {
209                        query.push_kv("next-token", &::aws_smithy_http::query::fmt_string(inner_3));
210                    }
211                }
212                ::std::result::Result::Ok(())
213            }
214            #[allow(clippy::unnecessary_wraps)]
215            fn update_http_builder(
216                input: &crate::operation::list_brands::ListBrandsInput,
217                builder: ::http::request::Builder,
218            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
219                let mut uri = ::std::string::String::new();
220                uri_base(input, &mut uri)?;
221                uri_query(input, &mut uri)?;
222                ::std::result::Result::Ok(builder.method("GET").uri(uri))
223            }
224            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
225            builder
226        };
227        let body = ::aws_smithy_types::body::SdkBody::from("");
228
229        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
230    }
231}
232#[derive(Debug)]
233struct ListBrandsEndpointParamsInterceptor;
234
235impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListBrandsEndpointParamsInterceptor {
236    fn name(&self) -> &'static str {
237        "ListBrandsEndpointParamsInterceptor"
238    }
239
240    fn read_before_execution(
241        &self,
242        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
243            '_,
244            ::aws_smithy_runtime_api::client::interceptors::context::Input,
245            ::aws_smithy_runtime_api::client::interceptors::context::Output,
246            ::aws_smithy_runtime_api::client::interceptors::context::Error,
247        >,
248        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
249    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
250        let _input = context
251            .input()
252            .downcast_ref::<ListBrandsInput>()
253            .ok_or("failed to downcast to ListBrandsInput")?;
254
255        let params = crate::config::endpoint::Params::builder()
256            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
257            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
258            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
259            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
260            .build()
261            .map_err(|err| {
262                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
263            })?;
264        cfg.interceptor_state()
265            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
266        ::std::result::Result::Ok(())
267    }
268}
269
270// The get_* functions below are generated from JMESPath expressions in the
271// operationContextParams trait. They target the operation's input shape.
272
273/// Error type for the `ListBrandsError` operation.
274#[non_exhaustive]
275#[derive(::std::fmt::Debug)]
276pub enum ListBrandsError {
277    /// <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
278    AccessDeniedException(crate::types::error::AccessDeniedException),
279    /// <p>An internal service exception.</p>
280    InternalServerException(crate::types::error::InternalServerException),
281    /// <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
282    InvalidRequestException(crate::types::error::InvalidRequestException),
283    /// <p>Access is throttled.</p>
284    ThrottlingException(crate::types::error::ThrottlingException),
285    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
286    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
287    variable wildcard pattern and check `.code()`:
288     \
289    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
290     \
291    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListBrandsError) for what information is available for the error.")]
292    Unhandled(crate::error::sealed_unhandled::Unhandled),
293}
294impl ListBrandsError {
295    /// Creates the `ListBrandsError::Unhandled` variant from any error type.
296    pub fn unhandled(
297        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
298    ) -> Self {
299        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
300            source: err.into(),
301            meta: ::std::default::Default::default(),
302        })
303    }
304
305    /// Creates the `ListBrandsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
306    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
307        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
308            source: err.clone().into(),
309            meta: err,
310        })
311    }
312    ///
313    /// Returns error metadata, which includes the error code, message,
314    /// request ID, and potentially additional information.
315    ///
316    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
317        match self {
318            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::Unhandled(e) => &e.meta,
323        }
324    }
325    /// Returns `true` if the error kind is `ListBrandsError::AccessDeniedException`.
326    pub fn is_access_denied_exception(&self) -> bool {
327        matches!(self, Self::AccessDeniedException(_))
328    }
329    /// Returns `true` if the error kind is `ListBrandsError::InternalServerException`.
330    pub fn is_internal_server_exception(&self) -> bool {
331        matches!(self, Self::InternalServerException(_))
332    }
333    /// Returns `true` if the error kind is `ListBrandsError::InvalidRequestException`.
334    pub fn is_invalid_request_exception(&self) -> bool {
335        matches!(self, Self::InvalidRequestException(_))
336    }
337    /// Returns `true` if the error kind is `ListBrandsError::ThrottlingException`.
338    pub fn is_throttling_exception(&self) -> bool {
339        matches!(self, Self::ThrottlingException(_))
340    }
341}
342impl ::std::error::Error for ListBrandsError {
343    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
344        match self {
345            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
346            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
347            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
348            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
349            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
350        }
351    }
352}
353impl ::std::fmt::Display for ListBrandsError {
354    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
355        match self {
356            Self::AccessDeniedException(_inner) => _inner.fmt(f),
357            Self::InternalServerException(_inner) => _inner.fmt(f),
358            Self::InvalidRequestException(_inner) => _inner.fmt(f),
359            Self::ThrottlingException(_inner) => _inner.fmt(f),
360            Self::Unhandled(_inner) => {
361                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
362                    write!(f, "unhandled error ({code})")
363                } else {
364                    f.write_str("unhandled error")
365                }
366            }
367        }
368    }
369}
370impl ::aws_smithy_types::retry::ProvideErrorKind for ListBrandsError {
371    fn code(&self) -> ::std::option::Option<&str> {
372        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
373    }
374    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
375        ::std::option::Option::None
376    }
377}
378impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListBrandsError {
379    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
380        match self {
381            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
382            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
383            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
385            Self::Unhandled(_inner) => &_inner.meta,
386        }
387    }
388}
389impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListBrandsError {
390    fn create_unhandled_error(
391        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
392        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
393    ) -> Self {
394        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
395            source,
396            meta: meta.unwrap_or_default(),
397        })
398    }
399}
400impl ::aws_types::request_id::RequestId for crate::operation::list_brands::ListBrandsError {
401    fn request_id(&self) -> Option<&str> {
402        self.meta().request_id()
403    }
404}
405
406pub use crate::operation::list_brands::_list_brands_output::ListBrandsOutput;
407
408pub use crate::operation::list_brands::_list_brands_input::ListBrandsInput;
409
410mod _list_brands_input;
411
412mod _list_brands_output;
413
414/// Builders
415pub mod builders;
416
417/// Paginator for this operation
418pub mod paginator;