aws_sdk_workdocs/client/
describe_comments.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeComments`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`authentication_token(impl Into<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::set_authentication_token):<br>required: **false**<br><p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p><br>
8    ///   - [`document_id(impl Into<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::set_document_id):<br>required: **true**<br><p>The ID of the document.</p><br>
9    ///   - [`version_id(impl Into<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::set_version_id):<br>required: **true**<br><p>The ID of the document version.</p><br>
10    ///   - [`limit(i32)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of items to return.</p><br>
11    ///   - [`marker(impl Into<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::set_marker):<br>required: **false**<br><p>The marker for the next set of results. This marker was received from a previous call.</p><br>
12    /// - On success, responds with [`DescribeCommentsOutput`](crate::operation::describe_comments::DescribeCommentsOutput) with field(s):
13    ///   - [`comments(Option<Vec::<Comment>>)`](crate::operation::describe_comments::DescribeCommentsOutput::comments): <p>The list of comments for the specified document version.</p>
14    ///   - [`marker(Option<String>)`](crate::operation::describe_comments::DescribeCommentsOutput::marker): <p>The marker for the next set of results. This marker was received from a previous call.</p>
15    /// - On failure, responds with [`SdkError<DescribeCommentsError>`](crate::operation::describe_comments::DescribeCommentsError)
16    pub fn describe_comments(&self) -> crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder {
17        crate::operation::describe_comments::builders::DescribeCommentsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_workdocs/client/describe_comments.rs

aws_sdk_workdocs/client/
describe_comments.rs
