aws_sdk_quicksight/operation/
list_templates.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListTemplates`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListTemplates;
6impl ListTemplates {
7    /// Creates a new `ListTemplates`
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_templates::ListTemplatesInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_templates::ListTemplatesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_templates::ListTemplatesError,
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_templates::ListTemplatesError>()
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_templates::ListTemplatesOutput>()
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_templates::ListTemplatesInput,
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", "ListTemplates", 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.ListTemplates",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "ListTemplates",
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 ListTemplates {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListTemplates");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            ListTemplatesRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            ListTemplatesResponseDeserializer,
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            "ListTemplates",
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("ListTemplates")
128            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
129            .with_interceptor(ListTemplatesEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::list_templates::ListTemplatesError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::list_templates::ListTemplatesError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::list_templates::ListTemplatesError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct ListTemplatesResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListTemplatesResponseDeserializer {
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_list_templates::de_list_templates_http_error(status, headers, body)
159        } else {
160            crate::protocol_serde::shape_list_templates::de_list_templates_http_response(status, headers, body)
161        };
162        crate::protocol_serde::type_erase_result(parse_result)
163    }
164}
165#[derive(Debug)]
166struct ListTemplatesRequestSerializer;
167impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListTemplatesRequestSerializer {
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::list_templates::ListTemplatesInput>()
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::list_templates::ListTemplatesInput,
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                ::std::write!(output, "/accounts/{AwsAccountId}/templates", AwsAccountId = aws_account_id).expect("formatting should succeed");
199                ::std::result::Result::Ok(())
200            }
201            fn uri_query(
202                _input: &crate::operation::list_templates::ListTemplatesInput,
203                mut output: &mut ::std::string::String,
204            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
205                let mut query = ::aws_smithy_http::query::Writer::new(output);
206                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
207                    {
208                        query.push_kv("next-token", &::aws_smithy_http::query::fmt_string(inner_2));
209                    }
210                }
211                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
212                    {
213                        query.push_kv("max-result", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
214                    }
215                }
216                ::std::result::Result::Ok(())
217            }
218            #[allow(clippy::unnecessary_wraps)]
219            fn update_http_builder(
220                input: &crate::operation::list_templates::ListTemplatesInput,
221                builder: ::http::request::Builder,
222            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
223                let mut uri = ::std::string::String::new();
224                uri_base(input, &mut uri)?;
225                uri_query(input, &mut uri)?;
226                ::std::result::Result::Ok(builder.method("GET").uri(uri))
227            }
228            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
229            builder
230        };
231        let body = ::aws_smithy_types::body::SdkBody::from("");
232
233        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
234    }
235}
236#[derive(Debug)]
237struct ListTemplatesEndpointParamsInterceptor;
238
239impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListTemplatesEndpointParamsInterceptor {
240    fn name(&self) -> &'static str {
241        "ListTemplatesEndpointParamsInterceptor"
242    }
243
244    fn read_before_execution(
245        &self,
246        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
247            '_,
248            ::aws_smithy_runtime_api::client::interceptors::context::Input,
249            ::aws_smithy_runtime_api::client::interceptors::context::Output,
250            ::aws_smithy_runtime_api::client::interceptors::context::Error,
251        >,
252        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
253    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
254        let _input = context
255            .input()
256            .downcast_ref::<ListTemplatesInput>()
257            .ok_or("failed to downcast to ListTemplatesInput")?;
258
259        let params = crate::config::endpoint::Params::builder()
260            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
261            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
262            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
263            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
264            .build()
265            .map_err(|err| {
266                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
267            })?;
268        cfg.interceptor_state()
269            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
270        ::std::result::Result::Ok(())
271    }
272}
273
274// The get_* functions below are generated from JMESPath expressions in the
275// operationContextParams trait. They target the operation's input shape.
276
277/// Error type for the `ListTemplatesError` operation.
278#[non_exhaustive]
279#[derive(::std::fmt::Debug)]
280pub enum ListTemplatesError {
281    /// <p>An internal failure occurred.</p>
282    InternalFailureException(crate::types::error::InternalFailureException),
283    /// <p>The <code>NextToken</code> value isn't valid.</p>
284    InvalidNextTokenException(crate::types::error::InvalidNextTokenException),
285    /// <p>One or more parameters has a value that isn't valid.</p>
286    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
287    /// <p>One or more resources can't be found.</p>
288    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
289    /// <p>Access is throttled.</p>
290    ThrottlingException(crate::types::error::ThrottlingException),
291    /// <p>This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
292    UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
293    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
294    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
295    variable wildcard pattern and check `.code()`:
296     \
297    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
298     \
299    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListTemplatesError) for what information is available for the error.")]
300    Unhandled(crate::error::sealed_unhandled::Unhandled),
301}
302impl ListTemplatesError {
303    /// Creates the `ListTemplatesError::Unhandled` variant from any error type.
304    pub fn unhandled(
305        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
306    ) -> Self {
307        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
308            source: err.into(),
309            meta: ::std::default::Default::default(),
310        })
311    }
312
313    /// Creates the `ListTemplatesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
314    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
315        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
316            source: err.clone().into(),
317            meta: err,
318        })
319    }
320    ///
321    /// Returns error metadata, which includes the error code, message,
322    /// request ID, and potentially additional information.
323    ///
324    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
325        match self {
326            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::InvalidNextTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::Unhandled(e) => &e.meta,
333        }
334    }
335    /// Returns `true` if the error kind is `ListTemplatesError::InternalFailureException`.
336    pub fn is_internal_failure_exception(&self) -> bool {
337        matches!(self, Self::InternalFailureException(_))
338    }
339    /// Returns `true` if the error kind is `ListTemplatesError::InvalidNextTokenException`.
340    pub fn is_invalid_next_token_exception(&self) -> bool {
341        matches!(self, Self::InvalidNextTokenException(_))
342    }
343    /// Returns `true` if the error kind is `ListTemplatesError::InvalidParameterValueException`.
344    pub fn is_invalid_parameter_value_exception(&self) -> bool {
345        matches!(self, Self::InvalidParameterValueException(_))
346    }
347    /// Returns `true` if the error kind is `ListTemplatesError::ResourceNotFoundException`.
348    pub fn is_resource_not_found_exception(&self) -> bool {
349        matches!(self, Self::ResourceNotFoundException(_))
350    }
351    /// Returns `true` if the error kind is `ListTemplatesError::ThrottlingException`.
352    pub fn is_throttling_exception(&self) -> bool {
353        matches!(self, Self::ThrottlingException(_))
354    }
355    /// Returns `true` if the error kind is `ListTemplatesError::UnsupportedUserEditionException`.
356    pub fn is_unsupported_user_edition_exception(&self) -> bool {
357        matches!(self, Self::UnsupportedUserEditionException(_))
358    }
359}
360impl ::std::error::Error for ListTemplatesError {
361    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
362        match self {
363            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
364            Self::InvalidNextTokenException(_inner) => ::std::option::Option::Some(_inner),
365            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
366            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
367            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
368            Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
369            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
370        }
371    }
372}
373impl ::std::fmt::Display for ListTemplatesError {
374    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
375        match self {
376            Self::InternalFailureException(_inner) => _inner.fmt(f),
377            Self::InvalidNextTokenException(_inner) => _inner.fmt(f),
378            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
379            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
380            Self::ThrottlingException(_inner) => _inner.fmt(f),
381            Self::UnsupportedUserEditionException(_inner) => _inner.fmt(f),
382            Self::Unhandled(_inner) => {
383                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
384                    write!(f, "unhandled error ({code})")
385                } else {
386                    f.write_str("unhandled error")
387                }
388            }
389        }
390    }
391}
392impl ::aws_smithy_types::retry::ProvideErrorKind for ListTemplatesError {
393    fn code(&self) -> ::std::option::Option<&str> {
394        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
395    }
396    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
397        ::std::option::Option::None
398    }
399}
400impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListTemplatesError {
401    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
402        match self {
403            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::InvalidNextTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::Unhandled(_inner) => &_inner.meta,
410        }
411    }
412}
413impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListTemplatesError {
414    fn create_unhandled_error(
415        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
416        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
417    ) -> Self {
418        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
419            source,
420            meta: meta.unwrap_or_default(),
421        })
422    }
423}
424impl ::aws_types::request_id::RequestId for crate::operation::list_templates::ListTemplatesError {
425    fn request_id(&self) -> Option<&str> {
426        self.meta().request_id()
427    }
428}
429
430pub use crate::operation::list_templates::_list_templates_output::ListTemplatesOutput;
431
432pub use crate::operation::list_templates::_list_templates_input::ListTemplatesInput;
433
434mod _list_templates_input;
435
436mod _list_templates_output;
437
438/// Builders
439pub mod builders;
440
441/// Paginator for this operation
442pub mod paginator;
aws_sdk_quicksight/operation/list_templates.rs

aws_sdk_quicksight/operation/
list_templates.rs
