aws_sdk_workdocs/client/get_folder.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 [`GetFolder`](crate::operation::get_folder::builders::GetFolderFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`authentication_token(impl Into<String>)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::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 /// - [`folder_id(impl Into<String>)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::folder_id) / [`set_folder_id(Option<String>)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::set_folder_id):<br>required: **true**<br><p>The ID of the folder.</p><br>
8 /// - [`include_custom_metadata(bool)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::include_custom_metadata) / [`set_include_custom_metadata(Option<bool>)`](crate::operation::get_folder::builders::GetFolderFluentBuilder::set_include_custom_metadata):<br>required: **false**<br><p>Set to TRUE to include custom metadata in the response.</p><br>
9 /// - On success, responds with [`GetFolderOutput`](crate::operation::get_folder::GetFolderOutput) with field(s):
10 /// - [`metadata(Option<FolderMetadata>)`](crate::operation::get_folder::GetFolderOutput::metadata): <p>The metadata of the folder.</p>
11 /// - [`custom_metadata(Option<HashMap::<String, String>>)`](crate::operation::get_folder::GetFolderOutput::custom_metadata): <p>The custom metadata on the folder.</p>
12 /// - On failure, responds with [`SdkError<GetFolderError>`](crate::operation::get_folder::GetFolderError)
13 pub fn get_folder(&self) -> crate::operation::get_folder::builders::GetFolderFluentBuilder {
14 crate::operation::get_folder::builders::GetFolderFluentBuilder::new(self.handle.clone())
15 }
16}