aws_sdk_workdocs/operation/
get_document.rs

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

aws_sdk_workdocs/operation/
get_document.rs
