// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeIndex`](crate::operation::describe_index::builders::DescribeIndexFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`id(impl Into<String>)`](crate::operation::describe_index::builders::DescribeIndexFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::describe_index::builders::DescribeIndexFluentBuilder::set_id):<br>required: **true**<br><p>The identifier of the index you want to get information on.</p><br>
    /// - On success, responds with [`DescribeIndexOutput`](crate::operation::describe_index::DescribeIndexOutput) with field(s):
    ///   - [`name(Option<String>)`](crate::operation::describe_index::DescribeIndexOutput::name): <p>The name of the index.</p>
    ///   - [`id(Option<String>)`](crate::operation::describe_index::DescribeIndexOutput::id): <p>The identifier of the index.</p>
    ///   - [`edition(Option<IndexEdition>)`](crate::operation::describe_index::DescribeIndexOutput::edition): <p>The Amazon Kendra edition used for the index. You decide the edition when you create the index.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_index::DescribeIndexOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.</p>
    ///   - [`server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>)`](crate::operation::describe_index::DescribeIndexOutput::server_side_encryption_configuration): <p>The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.</p>
    ///   - [`status(Option<IndexStatus>)`](crate::operation::describe_index::DescribeIndexOutput::status): <p>The current status of the index. When the value is <code>ACTIVE</code>, the index is ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_index::DescribeIndexOutput::description): <p>The description for the index.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_index::DescribeIndexOutput::created_at): <p>The Unix timestamp when the index was created.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_index::DescribeIndexOutput::updated_at): <p>The Unix when the index was last updated.</p>
    ///   - [`document_metadata_configurations(Option<Vec::<DocumentMetadataConfiguration>>)`](crate::operation::describe_index::DescribeIndexOutput::document_metadata_configurations): <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.</p>
    ///   - [`index_statistics(Option<IndexStatistics>)`](crate::operation::describe_index::DescribeIndexOutput::index_statistics): <p>Provides information about the number of FAQ questions and answers and the number of text documents indexed.</p>
    ///   - [`error_message(Option<String>)`](crate::operation::describe_index::DescribeIndexOutput::error_message): <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>
    ///   - [`capacity_units(Option<CapacityUnitsConfiguration>)`](crate::operation::describe_index::DescribeIndexOutput::capacity_units): <p>For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>
    ///   - [`user_token_configurations(Option<Vec::<UserTokenConfiguration>>)`](crate::operation::describe_index::DescribeIndexOutput::user_token_configurations): <p>The user token configuration for the Amazon Kendra index.</p>
    ///   - [`user_context_policy(Option<UserContextPolicy>)`](crate::operation::describe_index::DescribeIndexOutput::user_context_policy): <p>The user context policy for the Amazon Kendra index.</p>
    ///   - [`user_group_resolution_configuration(Option<UserGroupResolutionConfiguration>)`](crate::operation::describe_index::DescribeIndexOutput::user_group_resolution_configuration): <p>Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.</p>
    /// - On failure, responds with [`SdkError<DescribeIndexError>`](crate::operation::describe_index::DescribeIndexError)
    pub fn describe_index(&self) -> crate::operation::describe_index::builders::DescribeIndexFluentBuilder {
        crate::operation::describe_index::builders::DescribeIndexFluentBuilder::new(self.handle.clone())
    }
}