aws_sdk_kendra/operation/
query.rs

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

aws_sdk_kendra/operation/
query.rs
