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

aws_sdk_workdocs/operation/
describe_comments.rs
