// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`DescribeFieldIndexes`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`log_group_identifiers(impl Into<String>)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::log_group_identifiers) / [`set_log_group_identifiers(Option<Vec::<String>>)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::set_log_group_identifiers):<br>required: **true**<br><p>An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.</p><br>
/// - [`index_categories(IndexCategory)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::index_categories) / [`set_index_categories(Option<Vec::<IndexCategory>>)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::set_index_categories):<br>required: **false**<br><p>The index categories to return. The following values are supported:</p> <ul> <li> <p><code>DEFAULT</code>: Fields that CloudWatch Logs indexes by default. Examples include <code>@logStream</code> and <code>@data_format</code>.</p></li> <li> <p><code>CUSTOM</code>: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.</p></li> <li> <p><code>AUTO</code>: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.</p></li> <li> <p><code>INACTIVE</code>: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.</p></li> </ul> <p>If you omit this parameter, the response includes the <code>DEFAULT</code>, <code>CUSTOM</code>, and <code>INACTIVE</code> categories.</p> <p>For more information about automatically indexed fields and using the <code>AUTO</code> category, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html">Automatically indexed fields</a>.</p><br>
/// - [`next_token(impl Into<String>)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. The token expires after 24 hours.</p><br>
/// - On success, responds with [`DescribeFieldIndexesOutput`](crate::operation::describe_field_indexes::DescribeFieldIndexesOutput) with field(s):
/// - [`field_indexes(Option<Vec::<FieldIndex>>)`](crate::operation::describe_field_indexes::DescribeFieldIndexesOutput::field_indexes): <p>An array containing the field index information.</p>
/// - [`next_token(Option<String>)`](crate::operation::describe_field_indexes::DescribeFieldIndexesOutput::next_token): <p>The token for the next set of items to return. The token expires after 24 hours.</p>
/// - On failure, responds with [`SdkError<DescribeFieldIndexesError>`](crate::operation::describe_field_indexes::DescribeFieldIndexesError)
pub fn describe_field_indexes(&self) -> crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder {
crate::operation::describe_field_indexes::builders::DescribeFieldIndexesFluentBuilder::new(self.handle.clone())
}
}