aws_sdk_directory/client/
describe_settings.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 [`DescribeSettings`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`directory_id(impl Into<String>)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::set_directory_id):<br>required: **true**<br><p>The identifier of the directory for which to retrieve information.</p><br>
7    ///   - [`status(DirectoryConfigurationStatus)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::status) / [`set_status(Option<DirectoryConfigurationStatus>)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::set_status):<br>required: **false**<br><p>The status of the directory settings for which to retrieve information.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>DescribeSettingsResult.NextToken</code> value from a previous call to <code>DescribeSettings</code>. Pass null if this is the first call.</p><br>
9    /// - On success, responds with [`DescribeSettingsOutput`](crate::operation::describe_settings::DescribeSettingsOutput) with field(s):
10    ///   - [`directory_id(Option<String>)`](crate::operation::describe_settings::DescribeSettingsOutput::directory_id): <p>The identifier of the directory.</p>
11    ///   - [`setting_entries(Option<Vec::<SettingEntry>>)`](crate::operation::describe_settings::DescribeSettingsOutput::setting_entries): <p>The list of <code>SettingEntry</code> objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <code>Limit</code> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_settings::DescribeSettingsOutput::next_token): <p>If not null, token that indicates that more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <code>DescribeSettings</code> to retrieve the next set of items.</p>
13    /// - On failure, responds with [`SdkError<DescribeSettingsError>`](crate::operation::describe_settings::DescribeSettingsError)
14    pub fn describe_settings(&self) -> crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder {
15        crate::operation::describe_settings::builders::DescribeSettingsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_directory/client/describe_settings.rs

aws_sdk_directory/client/
describe_settings.rs
