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_with_config(
154 &self,
155 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
156 _cfg: &::aws_smithy_types::config_bag::ConfigBag,
157 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
158 let (success, status) = (response.status().is_success(), response.status().as_u16());
159 let headers = response.headers();
160 let body = response.body().bytes().expect("body loaded");
161 #[allow(unused_mut)]
162 let mut force_error = false;
163 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
164 let parse_result = if !success && status != 200 || force_error {
165 crate::protocol_serde::shape_describe_comments::de_describe_comments_http_error(status, headers, body)
166 } else {
167 crate::protocol_serde::shape_describe_comments::de_describe_comments_http_response(status, headers, body)
168 };
169 crate::protocol_serde::type_erase_result(parse_result)
170 }
171}
172#[derive(Debug)]
173struct DescribeCommentsRequestSerializer;
174impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeCommentsRequestSerializer {
175 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
176 fn serialize_input(
177 &self,
178 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
179 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
180 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
181 let input = input
182 .downcast::<crate::operation::describe_comments::DescribeCommentsInput>()
183 .expect("correct type");
184 let _header_serialization_settings = _cfg
185 .load::<crate::serialization_settings::HeaderSerializationSettings>()
186 .cloned()
187 .unwrap_or_default();
188 let mut request_builder = {
189 #[allow(clippy::uninlined_format_args)]
190 fn uri_base(
191 _input: &crate::operation::describe_comments::DescribeCommentsInput,
192 output: &mut ::std::string::String,
193 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
194 use ::std::fmt::Write as _;
195 let input_1 = &_input.document_id;
196 let input_1 = input_1
197 .as_ref()
198 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("document_id", "cannot be empty or unset"))?;
199 let document_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
200 if document_id.is_empty() {
201 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
202 "document_id",
203 "cannot be empty or unset",
204 ));
205 }
206 let input_2 = &_input.version_id;
207 let input_2 = input_2
208 .as_ref()
209 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("version_id", "cannot be empty or unset"))?;
210 let version_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
211 if version_id.is_empty() {
212 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
213 "version_id",
214 "cannot be empty or unset",
215 ));
216 }
217 ::std::write!(
218 output,
219 "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",
220 DocumentId = document_id,
221 VersionId = version_id
222 )
223 .expect("formatting should succeed");
224 ::std::result::Result::Ok(())
225 }
226 fn uri_query(
227 _input: &crate::operation::describe_comments::DescribeCommentsInput,
228 mut output: &mut ::std::string::String,
229 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
230 let mut query = ::aws_smithy_http::query::Writer::new(output);
231 if let ::std::option::Option::Some(inner_3) = &_input.limit {
232 {
233 query.push_kv("limit", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
234 }
235 }
236 if let ::std::option::Option::Some(inner_4) = &_input.marker {
237 {
238 query.push_kv("marker", &::aws_smithy_http::query::fmt_string(inner_4));
239 }
240 }
241 ::std::result::Result::Ok(())
242 }
243 #[allow(clippy::unnecessary_wraps)]
244 fn update_http_builder(
245 input: &crate::operation::describe_comments::DescribeCommentsInput,
246 builder: ::http_1x::request::Builder,
247 ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
248 let mut uri = ::std::string::String::new();
249 uri_base(input, &mut uri)?;
250 uri_query(input, &mut uri)?;
251 let builder = crate::protocol_serde::shape_describe_comments::ser_describe_comments_headers(input, builder)?;
252 ::std::result::Result::Ok(builder.method("GET").uri(uri))
253 }
254 let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
255 builder
256 };
257 let body = ::aws_smithy_types::body::SdkBody::from("");
258
259 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
260 }
261}
262#[derive(Debug)]
263struct DescribeCommentsEndpointParamsInterceptor;
264
265#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
266impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeCommentsEndpointParamsInterceptor {
267 fn name(&self) -> &'static str {
268 "DescribeCommentsEndpointParamsInterceptor"
269 }
270
271 fn read_before_execution(
272 &self,
273 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
274 '_,
275 ::aws_smithy_runtime_api::client::interceptors::context::Input,
276 ::aws_smithy_runtime_api::client::interceptors::context::Output,
277 ::aws_smithy_runtime_api::client::interceptors::context::Error,
278 >,
279 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
280 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
281 let _input = context
282 .input()
283 .downcast_ref::<DescribeCommentsInput>()
284 .ok_or("failed to downcast to DescribeCommentsInput")?;
285
286 let params = crate::config::endpoint::Params::builder()
287 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
288 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
289 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
290 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
291 .build()
292 .map_err(|err| {
293 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
294 })?;
295 cfg.interceptor_state()
296 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
297 ::std::result::Result::Ok(())
298 }
299}
300
301#[non_exhaustive]
306#[derive(::std::fmt::Debug)]
307pub enum DescribeCommentsError {
308 EntityNotExistsException(crate::types::error::EntityNotExistsException),
310 FailedDependencyException(crate::types::error::FailedDependencyException),
312 ProhibitedStateException(crate::types::error::ProhibitedStateException),
314 ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
316 UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
318 UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
320 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
322 variable wildcard pattern and check `.code()`:
323 \
324 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
325 \
326 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeCommentsError) for what information is available for the error.")]
327 Unhandled(crate::error::sealed_unhandled::Unhandled),
328}
329impl DescribeCommentsError {
330 pub fn unhandled(
332 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
333 ) -> Self {
334 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
335 source: err.into(),
336 meta: ::std::default::Default::default(),
337 })
338 }
339
340 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
342 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
343 source: err.clone().into(),
344 meta: err,
345 })
346 }
347 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
352 match self {
353 Self::EntityNotExistsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
354 Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
355 Self::ProhibitedStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
356 Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357 Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
358 Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
359 Self::Unhandled(e) => &e.meta,
360 }
361 }
362 pub fn is_entity_not_exists_exception(&self) -> bool {
364 matches!(self, Self::EntityNotExistsException(_))
365 }
366 pub fn is_failed_dependency_exception(&self) -> bool {
368 matches!(self, Self::FailedDependencyException(_))
369 }
370 pub fn is_prohibited_state_exception(&self) -> bool {
372 matches!(self, Self::ProhibitedStateException(_))
373 }
374 pub fn is_service_unavailable_exception(&self) -> bool {
376 matches!(self, Self::ServiceUnavailableException(_))
377 }
378 pub fn is_unauthorized_operation_exception(&self) -> bool {
380 matches!(self, Self::UnauthorizedOperationException(_))
381 }
382 pub fn is_unauthorized_resource_access_exception(&self) -> bool {
384 matches!(self, Self::UnauthorizedResourceAccessException(_))
385 }
386}
387impl ::std::error::Error for DescribeCommentsError {
388 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
389 match self {
390 Self::EntityNotExistsException(_inner) => ::std::option::Option::Some(_inner),
391 Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
392 Self::ProhibitedStateException(_inner) => ::std::option::Option::Some(_inner),
393 Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
394 Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
395 Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
396 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
397 }
398 }
399}
400impl ::std::fmt::Display for DescribeCommentsError {
401 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
402 match self {
403 Self::EntityNotExistsException(_inner) => _inner.fmt(f),
404 Self::FailedDependencyException(_inner) => _inner.fmt(f),
405 Self::ProhibitedStateException(_inner) => _inner.fmt(f),
406 Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
407 Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
408 Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
409 Self::Unhandled(_inner) => {
410 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
411 write!(f, "unhandled error ({code})")
412 } else {
413 f.write_str("unhandled error")
414 }
415 }
416 }
417 }
418}
419impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeCommentsError {
420 fn code(&self) -> ::std::option::Option<&str> {
421 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
422 }
423 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
424 ::std::option::Option::None
425 }
426}
427impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeCommentsError {
428 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
429 match self {
430 Self::EntityNotExistsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431 Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432 Self::ProhibitedStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433 Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434 Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435 Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436 Self::Unhandled(_inner) => &_inner.meta,
437 }
438 }
439}
440impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeCommentsError {
441 fn create_unhandled_error(
442 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
443 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
444 ) -> Self {
445 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
446 source,
447 meta: meta.unwrap_or_default(),
448 })
449 }
450}
451impl ::aws_types::request_id::RequestId for crate::operation::describe_comments::DescribeCommentsError {
452 fn request_id(&self) -> Option<&str> {
453 self.meta().request_id()
454 }
455}
456
457pub use crate::operation::describe_comments::_describe_comments_input::DescribeCommentsInput;
458
459pub use crate::operation::describe_comments::_describe_comments_output::DescribeCommentsOutput;
460
461mod _describe_comments_input;
462
463mod _describe_comments_output;
464
465pub mod builders;
467
468pub mod paginator;