aws_sdk_qconnect/operation/
search_message_templates.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `SearchMessageTemplates`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct SearchMessageTemplates;
6impl SearchMessageTemplates {
7    /// Creates a new `SearchMessageTemplates`
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::search_message_templates::SearchMessageTemplatesInput,
14    ) -> ::std::result::Result<
15        crate::operation::search_message_templates::SearchMessageTemplatesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::search_message_templates::SearchMessageTemplatesError,
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::search_message_templates::SearchMessageTemplatesError>()
27                    .expect("correct error type")
28            })
29        };
30        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "qconnect.SearchMessageTemplates",
36                "rpc.service" = "qconnect",
37                "rpc.method" = "SearchMessageTemplates",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::search_message_templates::SearchMessageTemplatesOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::search_message_templates::SearchMessageTemplatesInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("qconnect", "SearchMessageTemplates", input, runtime_plugins, stop_point)
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 SearchMessageTemplates {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("SearchMessageTemplates");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            SearchMessageTemplatesRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            SearchMessageTemplatesResponseDeserializer,
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::SensitiveOutput);
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "SearchMessageTemplates",
107            "qconnect",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("SearchMessageTemplates")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(SearchMessageTemplatesEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::search_message_templates::SearchMessageTemplatesError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::search_message_templates::SearchMessageTemplatesError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::search_message_templates::SearchMessageTemplatesError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct SearchMessageTemplatesResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for SearchMessageTemplatesResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_search_message_templates::de_search_message_templates_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_search_message_templates::de_search_message_templates_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct SearchMessageTemplatesRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for SearchMessageTemplatesRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::search_message_templates::SearchMessageTemplatesInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::search_message_templates::SearchMessageTemplatesInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                let input_1 = &_input.knowledge_base_id;
189                let input_1 = input_1.as_ref().ok_or_else(|| {
190                    ::aws_smithy_types::error::operation::BuildError::missing_field("knowledge_base_id", "cannot be empty or unset")
191                })?;
192                let knowledge_base_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
193                if knowledge_base_id.is_empty() {
194                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
195                        "knowledge_base_id",
196                        "cannot be empty or unset",
197                    ));
198                }
199                ::std::write!(
200                    output,
201                    "/knowledgeBases/{knowledgeBaseId}/search/messageTemplates",
202                    knowledgeBaseId = knowledge_base_id
203                )
204                .expect("formatting should succeed");
205                ::std::result::Result::Ok(())
206            }
207            fn uri_query(
208                _input: &crate::operation::search_message_templates::SearchMessageTemplatesInput,
209                mut output: &mut ::std::string::String,
210            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
211                let mut query = ::aws_smithy_http::query::Writer::new(output);
212                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
213                    {
214                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_2));
215                    }
216                }
217                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
218                    {
219                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
220                    }
221                }
222                ::std::result::Result::Ok(())
223            }
224            #[allow(clippy::unnecessary_wraps)]
225            fn update_http_builder(
226                input: &crate::operation::search_message_templates::SearchMessageTemplatesInput,
227                builder: ::http::request::Builder,
228            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
229                let mut uri = ::std::string::String::new();
230                uri_base(input, &mut uri)?;
231                uri_query(input, &mut uri)?;
232                ::std::result::Result::Ok(builder.method("POST").uri(uri))
233            }
234            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
235            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
236            builder
237        };
238        let body = ::aws_smithy_types::body::SdkBody::from(
239            crate::protocol_serde::shape_search_message_templates::ser_search_message_templates_input(&input)?,
240        );
241        if let Some(content_length) = body.content_length() {
242            let content_length = content_length.to_string();
243            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
244        }
245        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
246    }
247}
248#[derive(Debug)]
249struct SearchMessageTemplatesEndpointParamsInterceptor;
250
251impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SearchMessageTemplatesEndpointParamsInterceptor {
252    fn name(&self) -> &'static str {
253        "SearchMessageTemplatesEndpointParamsInterceptor"
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::<SearchMessageTemplatesInput>()
269            .ok_or("failed to downcast to SearchMessageTemplatesInput")?;
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 `SearchMessageTemplatesError` operation.
290#[non_exhaustive]
291#[derive(::std::fmt::Debug)]
292pub enum SearchMessageTemplatesError {
293    /// <p>You do not have sufficient access to perform this action.</p>
294    AccessDeniedException(crate::types::error::AccessDeniedException),
295    /// <p>The specified resource does not exist.</p>
296    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
297    /// <p>The throttling limit has been exceeded.</p>
298    ThrottlingException(crate::types::error::ThrottlingException),
299    /// <p>The input fails to satisfy the constraints specified by a service.</p>
300    ValidationException(crate::types::error::ValidationException),
301    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
302    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
303    variable wildcard pattern and check `.code()`:
304     \
305    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
306     \
307    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SearchMessageTemplatesError) for what information is available for the error.")]
308    Unhandled(crate::error::sealed_unhandled::Unhandled),
309}
310impl SearchMessageTemplatesError {
311    /// Creates the `SearchMessageTemplatesError::Unhandled` variant from any error type.
312    pub fn unhandled(
313        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
314    ) -> Self {
315        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
316            source: err.into(),
317            meta: ::std::default::Default::default(),
318        })
319    }
320
321    /// Creates the `SearchMessageTemplatesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
322    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
323        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
324            source: err.clone().into(),
325            meta: err,
326        })
327    }
328    ///
329    /// Returns error metadata, which includes the error code, message,
330    /// request ID, and potentially additional information.
331    ///
332    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
333        match self {
334            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::Unhandled(e) => &e.meta,
339        }
340    }
341    /// Returns `true` if the error kind is `SearchMessageTemplatesError::AccessDeniedException`.
342    pub fn is_access_denied_exception(&self) -> bool {
343        matches!(self, Self::AccessDeniedException(_))
344    }
345    /// Returns `true` if the error kind is `SearchMessageTemplatesError::ResourceNotFoundException`.
346    pub fn is_resource_not_found_exception(&self) -> bool {
347        matches!(self, Self::ResourceNotFoundException(_))
348    }
349    /// Returns `true` if the error kind is `SearchMessageTemplatesError::ThrottlingException`.
350    pub fn is_throttling_exception(&self) -> bool {
351        matches!(self, Self::ThrottlingException(_))
352    }
353    /// Returns `true` if the error kind is `SearchMessageTemplatesError::ValidationException`.
354    pub fn is_validation_exception(&self) -> bool {
355        matches!(self, Self::ValidationException(_))
356    }
357}
358impl ::std::error::Error for SearchMessageTemplatesError {
359    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
360        match self {
361            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
363            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
364            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
365            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
366        }
367    }
368}
369impl ::std::fmt::Display for SearchMessageTemplatesError {
370    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
371        match self {
372            Self::AccessDeniedException(_inner) => _inner.fmt(f),
373            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
374            Self::ThrottlingException(_inner) => _inner.fmt(f),
375            Self::ValidationException(_inner) => _inner.fmt(f),
376            Self::Unhandled(_inner) => {
377                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
378                    write!(f, "unhandled error ({code})")
379                } else {
380                    f.write_str("unhandled error")
381                }
382            }
383        }
384    }
385}
386impl ::aws_smithy_types::retry::ProvideErrorKind for SearchMessageTemplatesError {
387    fn code(&self) -> ::std::option::Option<&str> {
388        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
389    }
390    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
391        match self {
392            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
393            _ => ::std::option::Option::None,
394        }
395    }
396}
397impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for SearchMessageTemplatesError {
398    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
399        match self {
400            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::Unhandled(_inner) => &_inner.meta,
405        }
406    }
407}
408impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SearchMessageTemplatesError {
409    fn create_unhandled_error(
410        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
411        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
412    ) -> Self {
413        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
414            source,
415            meta: meta.unwrap_or_default(),
416        })
417    }
418}
419impl ::aws_types::request_id::RequestId for crate::operation::search_message_templates::SearchMessageTemplatesError {
420    fn request_id(&self) -> Option<&str> {
421        self.meta().request_id()
422    }
423}
424
425pub use crate::operation::search_message_templates::_search_message_templates_output::SearchMessageTemplatesOutput;
426
427pub use crate::operation::search_message_templates::_search_message_templates_input::SearchMessageTemplatesInput;
428
429mod _search_message_templates_input;
430
431mod _search_message_templates_output;
432
433/// Builders
434pub mod builders;
435
436/// Paginator for this operation
437pub mod paginator;