aws_sdk_workdocs/operation/
describe_comments.rs

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

aws_sdk_workdocs/operation/
describe_comments.rs
