aws_sdk_kendra/operation/
retrieve.rs

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

aws_sdk_kendra/operation/
retrieve.rs
