aws_sdk_qconnect/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("QConnect", "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                "QConnect.Retrieve",
55                "rpc.service" = "QConnect",
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::SensitiveOutput);
102        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("Retrieve", "QConnect"));
103        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
104        signing_options.double_uri_encode = true;
105        signing_options.content_sha256_header = false;
106        signing_options.normalize_uri_path = true;
107        signing_options.payload_override = None;
108
109        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
110            signing_options,
111            ..::std::default::Default::default()
112        });
113
114        ::std::option::Option::Some(cfg.freeze())
115    }
116
117    fn runtime_components(
118        &self,
119        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
120    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
121        #[allow(unused_mut)]
122        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("Retrieve")
123            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
124            .with_interceptor(RetrieveEndpointParamsInterceptor)
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
126                crate::operation::retrieve::RetrieveError,
127            >::new())
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
129                crate::operation::retrieve::RetrieveError,
130            >::new())
131            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
132                crate::operation::retrieve::RetrieveError,
133            >::new());
134
135        ::std::borrow::Cow::Owned(rcb)
136    }
137}
138
139#[derive(Debug)]
140struct RetrieveResponseDeserializer;
141impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for RetrieveResponseDeserializer {
142    fn deserialize_nonstreaming(
143        &self,
144        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
145    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
146        let (success, status) = (response.status().is_success(), response.status().as_u16());
147        let headers = response.headers();
148        let body = response.body().bytes().expect("body loaded");
149        #[allow(unused_mut)]
150        let mut force_error = false;
151        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
152        let parse_result = if !success && status != 200 || force_error {
153            crate::protocol_serde::shape_retrieve::de_retrieve_http_error(status, headers, body)
154        } else {
155            crate::protocol_serde::shape_retrieve::de_retrieve_http_response(status, headers, body)
156        };
157        crate::protocol_serde::type_erase_result(parse_result)
158    }
159}
160#[derive(Debug)]
161struct RetrieveRequestSerializer;
162impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for RetrieveRequestSerializer {
163    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
164    fn serialize_input(
165        &self,
166        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
167        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
168    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
169        let input = input.downcast::<crate::operation::retrieve::RetrieveInput>().expect("correct type");
170        let _header_serialization_settings = _cfg
171            .load::<crate::serialization_settings::HeaderSerializationSettings>()
172            .cloned()
173            .unwrap_or_default();
174        let mut request_builder = {
175            #[allow(clippy::uninlined_format_args)]
176            fn uri_base(
177                _input: &crate::operation::retrieve::RetrieveInput,
178                output: &mut ::std::string::String,
179            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
180                use ::std::fmt::Write as _;
181                let input_1 = &_input.assistant_id;
182                let input_1 = input_1
183                    .as_ref()
184                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("assistant_id", "cannot be empty or unset"))?;
185                let assistant_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
186                if assistant_id.is_empty() {
187                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
188                        "assistant_id",
189                        "cannot be empty or unset",
190                    ));
191                }
192                ::std::write!(output, "/assistants/{assistantId}/retrieve", assistantId = assistant_id).expect("formatting should succeed");
193                ::std::result::Result::Ok(())
194            }
195            #[allow(clippy::unnecessary_wraps)]
196            fn update_http_builder(
197                input: &crate::operation::retrieve::RetrieveInput,
198                builder: ::http::request::Builder,
199            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
200                let mut uri = ::std::string::String::new();
201                uri_base(input, &mut uri)?;
202                ::std::result::Result::Ok(builder.method("POST").uri(uri))
203            }
204            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
205            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
206            builder
207        };
208        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_retrieve::ser_retrieve_input(&input)?);
209        if let Some(content_length) = body.content_length() {
210            let content_length = content_length.to_string();
211            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
212        }
213        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
214    }
215}
216#[derive(Debug)]
217struct RetrieveEndpointParamsInterceptor;
218
219impl ::aws_smithy_runtime_api::client::interceptors::Intercept for RetrieveEndpointParamsInterceptor {
220    fn name(&self) -> &'static str {
221        "RetrieveEndpointParamsInterceptor"
222    }
223
224    fn read_before_execution(
225        &self,
226        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
227            '_,
228            ::aws_smithy_runtime_api::client::interceptors::context::Input,
229            ::aws_smithy_runtime_api::client::interceptors::context::Output,
230            ::aws_smithy_runtime_api::client::interceptors::context::Error,
231        >,
232        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
233    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
234        let _input = context
235            .input()
236            .downcast_ref::<RetrieveInput>()
237            .ok_or("failed to downcast to RetrieveInput")?;
238
239        let params = crate::config::endpoint::Params::builder()
240            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
241            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
242            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
243            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
244            .build()
245            .map_err(|err| {
246                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
247            })?;
248        cfg.interceptor_state()
249            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
250        ::std::result::Result::Ok(())
251    }
252}
253
254// The get_* functions below are generated from JMESPath expressions in the
255// operationContextParams trait. They target the operation's input shape.
256
257/// Error type for the `RetrieveError` operation.
258#[non_exhaustive]
259#[derive(::std::fmt::Debug)]
260pub enum RetrieveError {
261    /// <p>You do not have sufficient access to perform this action.</p>
262    AccessDeniedException(crate::types::error::AccessDeniedException),
263    /// <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
264    ConflictException(crate::types::error::ConflictException),
265    /// <p>The request failed because it depends on another request that failed.</p>
266    DependencyFailedException(crate::types::error::DependencyFailedException),
267    /// <p>The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.</p>
268    RequestTimeoutException(crate::types::error::RequestTimeoutException),
269    /// <p>The specified resource does not exist.</p>
270    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
271    /// <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
272    ServiceQuotaExceededException(crate::types::error::ServiceQuotaExceededException),
273    /// <p>The throttling limit has been exceeded.</p>
274    ThrottlingException(crate::types::error::ThrottlingException),
275    /// <p>The input fails to satisfy the constraints specified by a service.</p>
276    ValidationException(crate::types::error::ValidationException),
277    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
278    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
279    variable wildcard pattern and check `.code()`:
280     \
281    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
282     \
283    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-RetrieveError) for what information is available for the error.")]
284    Unhandled(crate::error::sealed_unhandled::Unhandled),
285}
286impl RetrieveError {
287    /// Creates the `RetrieveError::Unhandled` variant from any error type.
288    pub fn unhandled(
289        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
290    ) -> Self {
291        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
292            source: err.into(),
293            meta: ::std::default::Default::default(),
294        })
295    }
296
297    /// Creates the `RetrieveError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
298    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
299        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
300            source: err.clone().into(),
301            meta: err,
302        })
303    }
304    ///
305    /// Returns error metadata, which includes the error code, message,
306    /// request ID, and potentially additional information.
307    ///
308    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
309        match self {
310            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::DependencyFailedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::RequestTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::ServiceQuotaExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::Unhandled(e) => &e.meta,
319        }
320    }
321    /// Returns `true` if the error kind is `RetrieveError::AccessDeniedException`.
322    pub fn is_access_denied_exception(&self) -> bool {
323        matches!(self, Self::AccessDeniedException(_))
324    }
325    /// Returns `true` if the error kind is `RetrieveError::ConflictException`.
326    pub fn is_conflict_exception(&self) -> bool {
327        matches!(self, Self::ConflictException(_))
328    }
329    /// Returns `true` if the error kind is `RetrieveError::DependencyFailedException`.
330    pub fn is_dependency_failed_exception(&self) -> bool {
331        matches!(self, Self::DependencyFailedException(_))
332    }
333    /// Returns `true` if the error kind is `RetrieveError::RequestTimeoutException`.
334    pub fn is_request_timeout_exception(&self) -> bool {
335        matches!(self, Self::RequestTimeoutException(_))
336    }
337    /// Returns `true` if the error kind is `RetrieveError::ResourceNotFoundException`.
338    pub fn is_resource_not_found_exception(&self) -> bool {
339        matches!(self, Self::ResourceNotFoundException(_))
340    }
341    /// Returns `true` if the error kind is `RetrieveError::ServiceQuotaExceededException`.
342    pub fn is_service_quota_exceeded_exception(&self) -> bool {
343        matches!(self, Self::ServiceQuotaExceededException(_))
344    }
345    /// Returns `true` if the error kind is `RetrieveError::ThrottlingException`.
346    pub fn is_throttling_exception(&self) -> bool {
347        matches!(self, Self::ThrottlingException(_))
348    }
349    /// Returns `true` if the error kind is `RetrieveError::ValidationException`.
350    pub fn is_validation_exception(&self) -> bool {
351        matches!(self, Self::ValidationException(_))
352    }
353}
354impl ::std::error::Error for RetrieveError {
355    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
356        match self {
357            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
358            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
359            Self::DependencyFailedException(_inner) => ::std::option::Option::Some(_inner),
360            Self::RequestTimeoutException(_inner) => ::std::option::Option::Some(_inner),
361            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ServiceQuotaExceededException(_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 RetrieveError {
370    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
371        match self {
372            Self::AccessDeniedException(_inner) => _inner.fmt(f),
373            Self::ConflictException(_inner) => _inner.fmt(f),
374            Self::DependencyFailedException(_inner) => _inner.fmt(f),
375            Self::RequestTimeoutException(_inner) => _inner.fmt(f),
376            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
377            Self::ServiceQuotaExceededException(_inner) => _inner.fmt(f),
378            Self::ThrottlingException(_inner) => _inner.fmt(f),
379            Self::ValidationException(_inner) => _inner.fmt(f),
380            Self::Unhandled(_inner) => {
381                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
382                    write!(f, "unhandled error ({code})")
383                } else {
384                    f.write_str("unhandled error")
385                }
386            }
387        }
388    }
389}
390impl ::aws_smithy_types::retry::ProvideErrorKind for RetrieveError {
391    fn code(&self) -> ::std::option::Option<&str> {
392        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
393    }
394    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
395        match self {
396            Self::RequestTimeoutException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
397            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
398            _ => ::std::option::Option::None,
399        }
400    }
401}
402impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for RetrieveError {
403    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
404        match self {
405            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::DependencyFailedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::RequestTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::ServiceQuotaExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::Unhandled(_inner) => &_inner.meta,
414        }
415    }
416}
417impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for RetrieveError {
418    fn create_unhandled_error(
419        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
420        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
421    ) -> Self {
422        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
423            source,
424            meta: meta.unwrap_or_default(),
425        })
426    }
427}
428impl ::aws_types::request_id::RequestId for crate::operation::retrieve::RetrieveError {
429    fn request_id(&self) -> Option<&str> {
430        self.meta().request_id()
431    }
432}
433
434pub use crate::operation::retrieve::_retrieve_output::RetrieveOutput;
435
436pub use crate::operation::retrieve::_retrieve_input::RetrieveInput;
437
438mod _retrieve_input;
439
440mod _retrieve_output;
441
442/// Builders
443pub mod builders;