aws_sdk_workdocs/client/
get_document.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 [`GetDocument`](crate::operation::get_document::builders::GetDocumentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authentication_token(impl Into<String>)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::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>
7    ///   - [`document_id(impl Into<String>)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::set_document_id):<br>required: **true**<br><p>The ID of the document.</p><br>
8    ///   - [`include_custom_metadata(bool)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::include_custom_metadata) / [`set_include_custom_metadata(Option<bool>)`](crate::operation::get_document::builders::GetDocumentFluentBuilder::set_include_custom_metadata):<br>required: **false**<br><p>Set this to <code>TRUE</code> to include custom metadata in the response.</p><br>
9    /// - On success, responds with [`GetDocumentOutput`](crate::operation::get_document::GetDocumentOutput) with field(s):
10    ///   - [`metadata(Option<DocumentMetadata>)`](crate::operation::get_document::GetDocumentOutput::metadata): <p>The metadata details of the document.</p>
11    ///   - [`custom_metadata(Option<HashMap::<String, String>>)`](crate::operation::get_document::GetDocumentOutput::custom_metadata): <p>The custom metadata on the document.</p>
12    /// - On failure, responds with [`SdkError<GetDocumentError>`](crate::operation::get_document::GetDocumentError)
13    pub fn get_document(&self) -> crate::operation::get_document::builders::GetDocumentFluentBuilder {
14        crate::operation::get_document::builders::GetDocumentFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_workdocs/client/get_document.rs

aws_sdk_workdocs/client/
get_document.rs
