aws_sdk_cloudsearchdomain/operation/
suggest.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `Suggest`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct Suggest;
6impl Suggest {
7    /// Creates a new `Suggest`
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::suggest::SuggestInput,
14    ) -> ::std::result::Result<
15        crate::operation::suggest::SuggestOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::suggest::SuggestError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::suggest::SuggestError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::suggest::SuggestOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::suggest::SuggestInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("CloudSearch Domain", "Suggest", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "CloudSearch Domain.Suggest",
55                "rpc.service" = "CloudSearch Domain",
56                "rpc.method" = "Suggest",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for Suggest {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Suggest");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            SuggestRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            SuggestResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("Suggest")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
102            "Suggest",
103            "CloudSearch Domain",
104        ));
105        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
106        signing_options.double_uri_encode = true;
107        signing_options.content_sha256_header = false;
108        signing_options.normalize_uri_path = true;
109        signing_options.payload_override = None;
110
111        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
112            signing_options,
113            ..::std::default::Default::default()
114        });
115
116        ::std::option::Option::Some(cfg.freeze())
117    }
118
119    fn runtime_components(
120        &self,
121        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
122    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
123        #[allow(unused_mut)]
124        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("Suggest")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(SuggestEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::suggest::SuggestError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::suggest::SuggestError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::suggest::SuggestError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct SuggestResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for SuggestResponseDeserializer {
144    fn deserialize_nonstreaming(
145        &self,
146        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
147    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
148        let (success, status) = (response.status().is_success(), response.status().as_u16());
149        let headers = response.headers();
150        let body = response.body().bytes().expect("body loaded");
151        #[allow(unused_mut)]
152        let mut force_error = false;
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154        let parse_result = if !success && status != 200 || force_error {
155            crate::protocol_serde::shape_suggest::de_suggest_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_suggest::de_suggest_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct SuggestRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for SuggestRequestSerializer {
165    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
166    fn serialize_input(
167        &self,
168        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
169        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
171        let input = input.downcast::<crate::operation::suggest::SuggestInput>().expect("correct type");
172        let _header_serialization_settings = _cfg
173            .load::<crate::serialization_settings::HeaderSerializationSettings>()
174            .cloned()
175            .unwrap_or_default();
176        let mut request_builder = {
177            #[allow(clippy::uninlined_format_args)]
178            fn uri_base(
179                _input: &crate::operation::suggest::SuggestInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                ::std::write!(output, "/2013-01-01/suggest").expect("formatting should succeed");
184                ::std::result::Result::Ok(())
185            }
186            fn uri_query(
187                _input: &crate::operation::suggest::SuggestInput,
188                mut output: &mut ::std::string::String,
189            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
190                let mut query = ::aws_smithy_http::query::Writer::new(output);
191                query.push_kv("format", "sdk");
192                query.push_kv("pretty", "true");
193                let inner_1 = &_input.query;
194                let inner_1 = inner_1
195                    .as_ref()
196                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("query", "cannot be empty or unset"))?;
197                if inner_1.is_empty() {
198                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
199                        "query",
200                        "cannot be empty or unset",
201                    ));
202                }
203                query.push_kv("q", &::aws_smithy_http::query::fmt_string(inner_1));
204                let inner_2 = &_input.suggester;
205                let inner_2 = inner_2
206                    .as_ref()
207                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("suggester", "cannot be empty or unset"))?;
208                if inner_2.is_empty() {
209                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
210                        "suggester",
211                        "cannot be empty or unset",
212                    ));
213                }
214                query.push_kv("suggester", &::aws_smithy_http::query::fmt_string(inner_2));
215                if let ::std::option::Option::Some(inner_3) = &_input.size {
216                    {
217                        query.push_kv("size", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
218                    }
219                }
220                ::std::result::Result::Ok(())
221            }
222            #[allow(clippy::unnecessary_wraps)]
223            fn update_http_builder(
224                input: &crate::operation::suggest::SuggestInput,
225                builder: ::http::request::Builder,
226            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
227                let mut uri = ::std::string::String::new();
228                uri_base(input, &mut uri)?;
229                uri_query(input, &mut uri)?;
230                ::std::result::Result::Ok(builder.method("GET").uri(uri))
231            }
232            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
233            builder
234        };
235        let body = ::aws_smithy_types::body::SdkBody::from("");
236
237        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
238    }
239}
240#[derive(Debug)]
241struct SuggestEndpointParamsInterceptor;
242
243impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SuggestEndpointParamsInterceptor {
244    fn name(&self) -> &'static str {
245        "SuggestEndpointParamsInterceptor"
246    }
247
248    fn read_before_execution(
249        &self,
250        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
251            '_,
252            ::aws_smithy_runtime_api::client::interceptors::context::Input,
253            ::aws_smithy_runtime_api::client::interceptors::context::Output,
254            ::aws_smithy_runtime_api::client::interceptors::context::Error,
255        >,
256        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
257    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
258        let _input = context
259            .input()
260            .downcast_ref::<SuggestInput>()
261            .ok_or("failed to downcast to SuggestInput")?;
262
263        let params = crate::config::endpoint::Params::builder()
264            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
265            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
266            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
267            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
268            .build()
269            .map_err(|err| {
270                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
271            })?;
272        cfg.interceptor_state()
273            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
274        ::std::result::Result::Ok(())
275    }
276}
277
278// The get_* functions below are generated from JMESPath expressions in the
279// operationContextParams trait. They target the operation's input shape.
280
281/// Error type for the `SuggestError` operation.
282#[non_exhaustive]
283#[derive(::std::fmt::Debug)]
284pub enum SuggestError {
285    /// <p>Information about any problems encountered while processing a search request.</p>
286    SearchException(crate::types::error::SearchException),
287    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
288    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
289    variable wildcard pattern and check `.code()`:
290     \
291    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
292     \
293    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SuggestError) for what information is available for the error.")]
294    Unhandled(crate::error::sealed_unhandled::Unhandled),
295}
296impl SuggestError {
297    /// Creates the `SuggestError::Unhandled` variant from any error type.
298    pub fn unhandled(
299        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
300    ) -> Self {
301        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
302            source: err.into(),
303            meta: ::std::default::Default::default(),
304        })
305    }
306
307    /// Creates the `SuggestError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
308    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
309        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
310            source: err.clone().into(),
311            meta: err,
312        })
313    }
314    ///
315    /// Returns error metadata, which includes the error code, message,
316    /// request ID, and potentially additional information.
317    ///
318    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
319        match self {
320            Self::SearchException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::Unhandled(e) => &e.meta,
322        }
323    }
324    /// Returns `true` if the error kind is `SuggestError::SearchException`.
325    pub fn is_search_exception(&self) -> bool {
326        matches!(self, Self::SearchException(_))
327    }
328}
329impl ::std::error::Error for SuggestError {
330    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
331        match self {
332            Self::SearchException(_inner) => ::std::option::Option::Some(_inner),
333            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
334        }
335    }
336}
337impl ::std::fmt::Display for SuggestError {
338    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
339        match self {
340            Self::SearchException(_inner) => _inner.fmt(f),
341            Self::Unhandled(_inner) => {
342                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
343                    write!(f, "unhandled error ({code})")
344                } else {
345                    f.write_str("unhandled error")
346                }
347            }
348        }
349    }
350}
351impl ::aws_smithy_types::retry::ProvideErrorKind for SuggestError {
352    fn code(&self) -> ::std::option::Option<&str> {
353        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
354    }
355    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
356        ::std::option::Option::None
357    }
358}
359impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for SuggestError {
360    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
361        match self {
362            Self::SearchException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
363            Self::Unhandled(_inner) => &_inner.meta,
364        }
365    }
366}
367impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SuggestError {
368    fn create_unhandled_error(
369        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
370        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
371    ) -> Self {
372        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
373            source,
374            meta: meta.unwrap_or_default(),
375        })
376    }
377}
378impl ::aws_types::request_id::RequestId for crate::operation::suggest::SuggestError {
379    fn request_id(&self) -> Option<&str> {
380        self.meta().request_id()
381    }
382}
383
384pub use crate::operation::suggest::_suggest_output::SuggestOutput;
385
386pub use crate::operation::suggest::_suggest_input::SuggestInput;
387
388mod _suggest_input;
389
390mod _suggest_output;
391
392/// Builders
393pub mod builders;