aws_sdk_workdocs/client/describe_document_versions.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 [`DescribeDocumentVersions`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`authentication_token(impl Into<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::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_document_versions::builders::DescribeDocumentVersionsFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::set_document_id):<br>required: **true**<br><p>The ID of the document.</p><br>
9 /// - [`marker(impl Into<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::set_marker):<br>required: **false**<br><p>The marker for the next set of results. (You received this marker from a previous call.)</p><br>
10 /// - [`limit(i32)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of versions to return with this call.</p><br>
11 /// - [`include(impl Into<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::include) / [`set_include(Option<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::set_include):<br>required: **false**<br><p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.</p><br>
12 /// - [`fields(impl Into<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::fields) / [`set_fields(Option<String>)`](crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::set_fields):<br>required: **false**<br><p>Specify "SOURCE" to include initialized versions and a URL for the source document.</p><br>
13 /// - On success, responds with [`DescribeDocumentVersionsOutput`](crate::operation::describe_document_versions::DescribeDocumentVersionsOutput) with field(s):
14 /// - [`document_versions(Option<Vec::<DocumentVersionMetadata>>)`](crate::operation::describe_document_versions::DescribeDocumentVersionsOutput::document_versions): <p>The document versions.</p>
15 /// - [`marker(Option<String>)`](crate::operation::describe_document_versions::DescribeDocumentVersionsOutput::marker): <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
16 /// - On failure, responds with [`SdkError<DescribeDocumentVersionsError>`](crate::operation::describe_document_versions::DescribeDocumentVersionsError)
17 pub fn describe_document_versions(&self) -> crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder {
18 crate::operation::describe_document_versions::builders::DescribeDocumentVersionsFluentBuilder::new(self.handle.clone())
19 }
20}