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::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(GetDocumentEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::get_document::GetDocumentError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::get_document::GetDocumentError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::get_document::GetDocumentError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct GetDocumentResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetDocumentResponseDeserializer {
146    fn deserialize_nonstreaming(
147        &self,
148        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
149    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
150        let (success, status) = (response.status().is_success(), response.status().as_u16());
151        let headers = response.headers();
152        let body = response.body().bytes().expect("body loaded");
153        #[allow(unused_mut)]
154        let mut force_error = false;
155        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
156        let parse_result = if !success && status != 200 || force_error {
157            crate::protocol_serde::shape_get_document::de_get_document_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_get_document::de_get_document_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct GetDocumentRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetDocumentRequestSerializer {
167    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
168    fn serialize_input(
169        &self,
170        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
171        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
172    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
173        let input = input
174            .downcast::<crate::operation::get_document::GetDocumentInput>()
175            .expect("correct type");
176        let _header_serialization_settings = _cfg
177            .load::<crate::serialization_settings::HeaderSerializationSettings>()
178            .cloned()
179            .unwrap_or_default();
180        let mut request_builder = {
181            fn uri_base(
182                _input: &crate::operation::get_document::GetDocumentInput,
183                output: &mut ::std::string::String,
184            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
185                use ::std::fmt::Write as _;
186                let input_1 = &_input.document_id;
187                let input_1 = input_1
188                    .as_ref()
189                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("document_id", "cannot be empty or unset"))?;
190                let document_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
191                if document_id.is_empty() {
192                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
193                        "document_id",
194                        "cannot be empty or unset",
195                    ));
196                }
197                ::std::write!(output, "/api/v1/documents/{DocumentId}", DocumentId = document_id).expect("formatting should succeed");
198                ::std::result::Result::Ok(())
199            }
200            fn uri_query(
201                _input: &crate::operation::get_document::GetDocumentInput,
202                mut output: &mut ::std::string::String,
203            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
204                let mut query = ::aws_smithy_http::query::Writer::new(output);
205                if let ::std::option::Option::Some(inner_2) = &_input.include_custom_metadata {
206                    {
207                        query.push_kv("includeCustomMetadata", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
208                    }
209                }
210                ::std::result::Result::Ok(())
211            }
212            #[allow(clippy::unnecessary_wraps)]
213            fn update_http_builder(
214                input: &crate::operation::get_document::GetDocumentInput,
215                builder: ::http::request::Builder,
216            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
217                let mut uri = ::std::string::String::new();
218                uri_base(input, &mut uri)?;
219                uri_query(input, &mut uri)?;
220                let builder = crate::protocol_serde::shape_get_document::ser_get_document_headers(input, builder)?;
221                ::std::result::Result::Ok(builder.method("GET").uri(uri))
222            }
223            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
224            builder
225        };
226        let body = ::aws_smithy_types::body::SdkBody::from("");
227
228        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
229    }
230}
231#[derive(Debug)]
232struct GetDocumentEndpointParamsInterceptor;
233
234impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetDocumentEndpointParamsInterceptor {
235    fn name(&self) -> &'static str {
236        "GetDocumentEndpointParamsInterceptor"
237    }
238
239    fn read_before_execution(
240        &self,
241        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
242            '_,
243            ::aws_smithy_runtime_api::client::interceptors::context::Input,
244            ::aws_smithy_runtime_api::client::interceptors::context::Output,
245            ::aws_smithy_runtime_api::client::interceptors::context::Error,
246        >,
247        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
248    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
249        let _input = context
250            .input()
251            .downcast_ref::<GetDocumentInput>()
252            .ok_or("failed to downcast to GetDocumentInput")?;
253
254        let params = crate::config::endpoint::Params::builder()
255            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
256            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
257            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
258            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
259            .build()
260            .map_err(|err| {
261                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
262            })?;
263        cfg.interceptor_state()
264            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
265        ::std::result::Result::Ok(())
266    }
267}
268
269// The get_* functions below are generated from JMESPath expressions in the
270// operationContextParams trait. They target the operation's input shape.
271
272/// Error type for the `GetDocumentError` operation.
273#[non_exhaustive]
274#[derive(::std::fmt::Debug)]
275pub enum GetDocumentError {
276    /// <p>The resource does not exist.</p>
277    EntityNotExistsException(crate::types::error::EntityNotExistsException),
278    /// <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>
279    FailedDependencyException(crate::types::error::FailedDependencyException),
280    /// <p>The pagination marker or limit fields are not valid.</p>
281    InvalidArgumentException(crate::types::error::InvalidArgumentException),
282    /// <p>The password is invalid.</p>
283    InvalidPasswordException(crate::types::error::InvalidPasswordException),
284    /// <p>One or more of the dependencies is unavailable.</p>
285    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
286    /// <p>The operation is not permitted.</p>
287    UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
288    /// <p>The caller does not have access to perform the action on the resource.</p>
289    UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
290    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
291    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
292    variable wildcard pattern and check `.code()`:
293     \
294    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
295     \
296    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetDocumentError) for what information is available for the error.")]
297    Unhandled(crate::error::sealed_unhandled::Unhandled),
298}
299impl GetDocumentError {
300    /// Creates the `GetDocumentError::Unhandled` variant from any error type.
301    pub fn unhandled(
302        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
303    ) -> Self {
304        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
305            source: err.into(),
306            meta: ::std::default::Default::default(),
307        })
308    }
309
310    /// Creates the `GetDocumentError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
311    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
312        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
313            source: err.clone().into(),
314            meta: err,
315        })
316    }
317    ///
318    /// Returns error metadata, which includes the error code, message,
319    /// request ID, and potentially additional information.
320    ///
321    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
322        match self {
323            Self::EntityNotExistsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::InvalidArgumentException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::InvalidPasswordException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::Unhandled(e) => &e.meta,
331        }
332    }
333    /// Returns `true` if the error kind is `GetDocumentError::EntityNotExistsException`.
334    pub fn is_entity_not_exists_exception(&self) -> bool {
335        matches!(self, Self::EntityNotExistsException(_))
336    }
337    /// Returns `true` if the error kind is `GetDocumentError::FailedDependencyException`.
338    pub fn is_failed_dependency_exception(&self) -> bool {
339        matches!(self, Self::FailedDependencyException(_))
340    }
341    /// Returns `true` if the error kind is `GetDocumentError::InvalidArgumentException`.
342    pub fn is_invalid_argument_exception(&self) -> bool {
343        matches!(self, Self::InvalidArgumentException(_))
344    }
345    /// Returns `true` if the error kind is `GetDocumentError::InvalidPasswordException`.
346    pub fn is_invalid_password_exception(&self) -> bool {
347        matches!(self, Self::InvalidPasswordException(_))
348    }
349    /// Returns `true` if the error kind is `GetDocumentError::ServiceUnavailableException`.
350    pub fn is_service_unavailable_exception(&self) -> bool {
351        matches!(self, Self::ServiceUnavailableException(_))
352    }
353    /// Returns `true` if the error kind is `GetDocumentError::UnauthorizedOperationException`.
354    pub fn is_unauthorized_operation_exception(&self) -> bool {
355        matches!(self, Self::UnauthorizedOperationException(_))
356    }
357    /// Returns `true` if the error kind is `GetDocumentError::UnauthorizedResourceAccessException`.
358    pub fn is_unauthorized_resource_access_exception(&self) -> bool {
359        matches!(self, Self::UnauthorizedResourceAccessException(_))
360    }
361}
362impl ::std::error::Error for GetDocumentError {
363    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
364        match self {
365            Self::EntityNotExistsException(_inner) => ::std::option::Option::Some(_inner),
366            Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InvalidArgumentException(_inner) => ::std::option::Option::Some(_inner),
368            Self::InvalidPasswordException(_inner) => ::std::option::Option::Some(_inner),
369            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
370            Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
371            Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
372            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
373        }
374    }
375}
376impl ::std::fmt::Display for GetDocumentError {
377    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
378        match self {
379            Self::EntityNotExistsException(_inner) => _inner.fmt(f),
380            Self::FailedDependencyException(_inner) => _inner.fmt(f),
381            Self::InvalidArgumentException(_inner) => _inner.fmt(f),
382            Self::InvalidPasswordException(_inner) => _inner.fmt(f),
383            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
384            Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
385            Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
386            Self::Unhandled(_inner) => {
387                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
388                    write!(f, "unhandled error ({code})")
389                } else {
390                    f.write_str("unhandled error")
391                }
392            }
393        }
394    }
395}
396impl ::aws_smithy_types::retry::ProvideErrorKind for GetDocumentError {
397    fn code(&self) -> ::std::option::Option<&str> {
398        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
399    }
400    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
401        ::std::option::Option::None
402    }
403}
404impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetDocumentError {
405    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
406        match self {
407            Self::EntityNotExistsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::InvalidArgumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::InvalidPasswordException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::Unhandled(_inner) => &_inner.meta,
415        }
416    }
417}
418impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetDocumentError {
419    fn create_unhandled_error(
420        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
421        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
422    ) -> Self {
423        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
424            source,
425            meta: meta.unwrap_or_default(),
426        })
427    }
428}
429impl ::aws_types::request_id::RequestId for crate::operation::get_document::GetDocumentError {
430    fn request_id(&self) -> Option<&str> {
431        self.meta().request_id()
432    }
433}
434
435pub use crate::operation::get_document::_get_document_output::GetDocumentOutput;
436
437pub use crate::operation::get_document::_get_document_input::GetDocumentInput;
438
439mod _get_document_input;
440
441mod _get_document_output;
442
443/// Builders
444pub mod builders;
aws_sdk_workdocs/operation/get_document.rs

aws_sdk_workdocs/operation/
get_document.rs
