aws_sdk_directory/client/

describe_client_authentication_settings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeClientAuthenticationSettings`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`directory_id(impl Into<String>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::set_directory_id):<br>required: **true**<br><p>The identifier of the directory for which to retrieve information.</p><br>
    ///   - [`r#type(ClientAuthenticationType)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::type) / [`set_type(Option<ClientAuthenticationType>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::set_type):<br>required: **false**<br><p>The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <i>DescribeClientAuthenticationSettingsResult.NextToken</i> value from a previous call to <code>DescribeClientAuthenticationSettings</code>. Pass null if this is the first call.</p><br>
    ///   - [`limit(i32)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.</p><br>
    /// - On success, responds with [`DescribeClientAuthenticationSettingsOutput`](crate::operation::describe_client_authentication_settings::DescribeClientAuthenticationSettingsOutput) with field(s):
    ///   - [`client_authentication_settings_info(Option<Vec::<ClientAuthenticationSettingInfo>>)`](crate::operation::describe_client_authentication_settings::DescribeClientAuthenticationSettingsOutput::client_authentication_settings_info): <p>Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_client_authentication_settings::DescribeClientAuthenticationSettingsOutput::next_token): <p>The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.</p>
    /// - On failure, responds with [`SdkError<DescribeClientAuthenticationSettingsError>`](crate::operation::describe_client_authentication_settings::DescribeClientAuthenticationSettingsError)
    pub fn describe_client_authentication_settings(
        &self,
    ) -> crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder {
        crate::operation::describe_client_authentication_settings::builders::DescribeClientAuthenticationSettingsFluentBuilder::new(
            self.handle.clone(),
        )
    }
}