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