aws_sdk_workdocs/client/
get_document_path.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 [`GetDocumentPath`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authentication_token(impl Into<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::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_path::builders::GetDocumentPathFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::set_document_id):<br>required: **true**<br><p>The ID of the document.</p><br>
8    ///   - [`limit(i32)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of levels in the hierarchy to return.</p><br>
9    ///   - [`fields(impl Into<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::fields) / [`set_fields(Option<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::set_fields):<br>required: **false**<br><p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p><br>
10    ///   - [`marker(impl Into<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::set_marker):<br>required: **false**<br><p>This value is not supported.</p><br>
11    /// - On success, responds with [`GetDocumentPathOutput`](crate::operation::get_document_path::GetDocumentPathOutput) with field(s):
12    ///   - [`path(Option<ResourcePath>)`](crate::operation::get_document_path::GetDocumentPathOutput::path): <p>The path information.</p>
13    /// - On failure, responds with [`SdkError<GetDocumentPathError>`](crate::operation::get_document_path::GetDocumentPathError)
14    pub fn get_document_path(&self) -> crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder {
15        crate::operation::get_document_path::builders::GetDocumentPathFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_workdocs/client/get_document_path.rs

aws_sdk_workdocs/client/
get_document_path.rs
