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