aws_sdk_workdocs/operation/
describe_document_versions.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeDocumentVersions;
6impl DescribeDocumentVersions {
7 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::describe_document_versions::DescribeDocumentVersionsInput,
14 ) -> ::std::result::Result<
15 crate::operation::describe_document_versions::DescribeDocumentVersionsOutput,
16 ::aws_smithy_runtime_api::client::result::SdkError<
17 crate::operation::describe_document_versions::DescribeDocumentVersionsError,
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::describe_document_versions::DescribeDocumentVersionsError>()
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::describe_document_versions::DescribeDocumentVersionsOutput>()
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::describe_document_versions::DescribeDocumentVersionsInput,
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 ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("workdocs", "DescribeDocumentVersions", input, runtime_plugins, stop_point)
54 .await
55 }
56
57 pub(crate) fn operation_runtime_plugins(
58 client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
59 client_config: &crate::config::Config,
60 config_override: ::std::option::Option<crate::config::Builder>,
61 ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
62 let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
63 runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
64 ::aws_runtime::auth::sigv4::SCHEME_ID,
65 ]));
66 if let ::std::option::Option::Some(config_override) = config_override {
67 for plugin in config_override.runtime_plugins.iter().cloned() {
68 runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
69 }
70 runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
71 config_override,
72 client_config.config.clone(),
73 &client_config.runtime_components,
74 ));
75 }
76 runtime_plugins
77 }
78}
79impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeDocumentVersions {
80 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeDocumentVersions");
82
83 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84 DescribeDocumentVersionsRequestSerializer,
85 ));
86 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87 DescribeDocumentVersionsResponseDeserializer,
88 ));
89
90 cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91 ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
92 ));
93
94 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
95 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
96 "DescribeDocumentVersions",
97 "workdocs",
98 ));
99 let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
100 signing_options.double_uri_encode = true;
101 signing_options.content_sha256_header = false;
102 signing_options.normalize_uri_path = true;
103 signing_options.payload_override = None;
104
105 cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
106 signing_options,
107 ..::std::default::Default::default()
108 });
109
110 ::std::option::Option::Some(cfg.freeze())
111 }
112
113 fn runtime_components(
114 &self,
115 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
116 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
117 #[allow(unused_mut)]
118 let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeDocumentVersions")
119 .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
120 .with_interceptor(DescribeDocumentVersionsEndpointParamsInterceptor)
121 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
122 crate::operation::describe_document_versions::DescribeDocumentVersionsError,
123 >::new())
124 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
125 crate::operation::describe_document_versions::DescribeDocumentVersionsError,
126 >::new())
127 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
128 crate::operation::describe_document_versions::DescribeDocumentVersionsError,
129 >::new());
130
131 ::std::borrow::Cow::Owned(rcb)
132 }
133}
134
135#[derive(Debug)]
136struct DescribeDocumentVersionsResponseDeserializer;
137impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeDocumentVersionsResponseDeserializer {
138 fn deserialize_nonstreaming(
139 &self,
140 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
141 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
142 let (success, status) = (response.status().is_success(), response.status().as_u16());
143 let headers = response.headers();
144 let body = response.body().bytes().expect("body loaded");
145 #[allow(unused_mut)]
146 let mut force_error = false;
147 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
148 let parse_result = if !success && status != 200 || force_error {
149 crate::protocol_serde::shape_describe_document_versions::de_describe_document_versions_http_error(status, headers, body)
150 } else {
151 crate::protocol_serde::shape_describe_document_versions::de_describe_document_versions_http_response(status, headers, body)
152 };
153 crate::protocol_serde::type_erase_result(parse_result)
154 }
155}
156#[derive(Debug)]
157struct DescribeDocumentVersionsRequestSerializer;
158impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeDocumentVersionsRequestSerializer {
159 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
160 fn serialize_input(
161 &self,
162 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
163 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
164 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
165 let input = input
166 .downcast::<crate::operation::describe_document_versions::DescribeDocumentVersionsInput>()
167 .expect("correct type");
168 let _header_serialization_settings = _cfg
169 .load::<crate::serialization_settings::HeaderSerializationSettings>()
170 .cloned()
171 .unwrap_or_default();
172 let mut request_builder = {
173 fn uri_base(
174 _input: &crate::operation::describe_document_versions::DescribeDocumentVersionsInput,
175 output: &mut ::std::string::String,
176 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
177 use ::std::fmt::Write as _;
178 let input_1 = &_input.document_id;
179 let input_1 = input_1
180 .as_ref()
181 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("document_id", "cannot be empty or unset"))?;
182 let document_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
183 if document_id.is_empty() {
184 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
185 "document_id",
186 "cannot be empty or unset",
187 ));
188 }
189 ::std::write!(output, "/api/v1/documents/{DocumentId}/versions", DocumentId = document_id).expect("formatting should succeed");
190 ::std::result::Result::Ok(())
191 }
192 fn uri_query(
193 _input: &crate::operation::describe_document_versions::DescribeDocumentVersionsInput,
194 mut output: &mut ::std::string::String,
195 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
196 let mut query = ::aws_smithy_http::query::Writer::new(output);
197 if let ::std::option::Option::Some(inner_2) = &_input.marker {
198 {
199 query.push_kv("marker", &::aws_smithy_http::query::fmt_string(inner_2));
200 }
201 }
202 if let ::std::option::Option::Some(inner_3) = &_input.limit {
203 {
204 query.push_kv("limit", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
205 }
206 }
207 if let ::std::option::Option::Some(inner_4) = &_input.include {
208 {
209 query.push_kv("include", &::aws_smithy_http::query::fmt_string(inner_4));
210 }
211 }
212 if let ::std::option::Option::Some(inner_5) = &_input.fields {
213 {
214 query.push_kv("fields", &::aws_smithy_http::query::fmt_string(inner_5));
215 }
216 }
217 ::std::result::Result::Ok(())
218 }
219 #[allow(clippy::unnecessary_wraps)]
220 fn update_http_builder(
221 input: &crate::operation::describe_document_versions::DescribeDocumentVersionsInput,
222 builder: ::http::request::Builder,
223 ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
224 let mut uri = ::std::string::String::new();
225 uri_base(input, &mut uri)?;
226 uri_query(input, &mut uri)?;
227 let builder = crate::protocol_serde::shape_describe_document_versions::ser_describe_document_versions_headers(input, builder)?;
228 ::std::result::Result::Ok(builder.method("GET").uri(uri))
229 }
230 let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
231 builder
232 };
233 let body = ::aws_smithy_types::body::SdkBody::from("");
234
235 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
236 }
237}
238#[derive(Debug)]
239struct DescribeDocumentVersionsEndpointParamsInterceptor;
240
241impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeDocumentVersionsEndpointParamsInterceptor {
242 fn name(&self) -> &'static str {
243 "DescribeDocumentVersionsEndpointParamsInterceptor"
244 }
245
246 fn read_before_execution(
247 &self,
248 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
249 '_,
250 ::aws_smithy_runtime_api::client::interceptors::context::Input,
251 ::aws_smithy_runtime_api::client::interceptors::context::Output,
252 ::aws_smithy_runtime_api::client::interceptors::context::Error,
253 >,
254 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
255 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
256 let _input = context
257 .input()
258 .downcast_ref::<DescribeDocumentVersionsInput>()
259 .ok_or("failed to downcast to DescribeDocumentVersionsInput")?;
260
261 let params = crate::config::endpoint::Params::builder()
262 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
263 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
264 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
265 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
266 .build()
267 .map_err(|err| {
268 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
269 })?;
270 cfg.interceptor_state()
271 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
272 ::std::result::Result::Ok(())
273 }
274}
275
276#[non_exhaustive]
281#[derive(::std::fmt::Debug)]
282pub enum DescribeDocumentVersionsError {
283 EntityNotExistsException(crate::types::error::EntityNotExistsException),
285 FailedDependencyException(crate::types::error::FailedDependencyException),
287 InvalidArgumentException(crate::types::error::InvalidArgumentException),
289 InvalidPasswordException(crate::types::error::InvalidPasswordException),
291 ProhibitedStateException(crate::types::error::ProhibitedStateException),
293 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
295 UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
297 UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
299 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
301 variable wildcard pattern and check `.code()`:
302 \
303 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
304 \
305 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeDocumentVersionsError) for what information is available for the error.")]
306 Unhandled(crate::error::sealed_unhandled::Unhandled),
307}
308impl DescribeDocumentVersionsError {
309 pub fn unhandled(
311 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
312 ) -> Self {
313 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
314 source: err.into(),
315 meta: ::std::default::Default::default(),
316 })
317 }
318
319 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
321 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
322 source: err.clone().into(),
323 meta: err,
324 })
325 }
326 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
331 match self {
332 Self::EntityNotExistsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333 Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334 Self::InvalidArgumentException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335 Self::InvalidPasswordException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336 Self::ProhibitedStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337 Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338 Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339 Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340 Self::Unhandled(e) => &e.meta,
341 }
342 }
343 pub fn is_entity_not_exists_exception(&self) -> bool {
345 matches!(self, Self::EntityNotExistsException(_))
346 }
347 pub fn is_failed_dependency_exception(&self) -> bool {
349 matches!(self, Self::FailedDependencyException(_))
350 }
351 pub fn is_invalid_argument_exception(&self) -> bool {
353 matches!(self, Self::InvalidArgumentException(_))
354 }
355 pub fn is_invalid_password_exception(&self) -> bool {
357 matches!(self, Self::InvalidPasswordException(_))
358 }
359 pub fn is_prohibited_state_exception(&self) -> bool {
361 matches!(self, Self::ProhibitedStateException(_))
362 }
363 pub fn is_service_unavailable_exception(&self) -> bool {
365 matches!(self, Self::ServiceUnavailableException(_))
366 }
367 pub fn is_unauthorized_operation_exception(&self) -> bool {
369 matches!(self, Self::UnauthorizedOperationException(_))
370 }
371 pub fn is_unauthorized_resource_access_exception(&self) -> bool {
373 matches!(self, Self::UnauthorizedResourceAccessException(_))
374 }
375}
376impl ::std::error::Error for DescribeDocumentVersionsError {
377 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
378 match self {
379 Self::EntityNotExistsException(_inner) => ::std::option::Option::Some(_inner),
380 Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
381 Self::InvalidArgumentException(_inner) => ::std::option::Option::Some(_inner),
382 Self::InvalidPasswordException(_inner) => ::std::option::Option::Some(_inner),
383 Self::ProhibitedStateException(_inner) => ::std::option::Option::Some(_inner),
384 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
385 Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
386 Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
387 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
388 }
389 }
390}
391impl ::std::fmt::Display for DescribeDocumentVersionsError {
392 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
393 match self {
394 Self::EntityNotExistsException(_inner) => _inner.fmt(f),
395 Self::FailedDependencyException(_inner) => _inner.fmt(f),
396 Self::InvalidArgumentException(_inner) => _inner.fmt(f),
397 Self::InvalidPasswordException(_inner) => _inner.fmt(f),
398 Self::ProhibitedStateException(_inner) => _inner.fmt(f),
399 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
400 Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
401 Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
402 Self::Unhandled(_inner) => {
403 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
404 write!(f, "unhandled error ({code})")
405 } else {
406 f.write_str("unhandled error")
407 }
408 }
409 }
410 }
411}
412impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeDocumentVersionsError {
413 fn code(&self) -> ::std::option::Option<&str> {
414 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
415 }
416 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
417 ::std::option::Option::None
418 }
419}
420impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeDocumentVersionsError {
421 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
422 match self {
423 Self::EntityNotExistsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424 Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425 Self::InvalidArgumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
426 Self::InvalidPasswordException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
427 Self::ProhibitedStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
428 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
429 Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
430 Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431 Self::Unhandled(_inner) => &_inner.meta,
432 }
433 }
434}
435impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeDocumentVersionsError {
436 fn create_unhandled_error(
437 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
438 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
439 ) -> Self {
440 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
441 source,
442 meta: meta.unwrap_or_default(),
443 })
444 }
445}
446impl ::aws_types::request_id::RequestId for crate::operation::describe_document_versions::DescribeDocumentVersionsError {
447 fn request_id(&self) -> Option<&str> {
448 self.meta().request_id()
449 }
450}
451
452pub use crate::operation::describe_document_versions::_describe_document_versions_output::DescribeDocumentVersionsOutput;
453
454pub use crate::operation::describe_document_versions::_describe_document_versions_input::DescribeDocumentVersionsInput;
455
456mod _describe_document_versions_input;
457
458mod _describe_document_versions_output;
459
460pub mod builders;
462
463pub mod paginator;