See: newDescribeIndex smart constructor.

Create a value of DescribeIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeIndex, describeIndex_id - The identifier of the index you want to get information on.

The identifier of the index you want to get information on.

See: newDescribeIndexResponse smart constructor.

Create a value of DescribeIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityUnits:DescribeIndexResponse', describeIndexResponse_capacityUnits - 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 Adjusting capacity.

DescribeIndexResponse, describeIndexResponse_createdAt - The Unix datetime that the index was created.

$sel:description:DescribeIndexResponse', describeIndexResponse_description - The description for the index.

$sel:documentMetadataConfigurations:DescribeIndexResponse', describeIndexResponse_documentMetadataConfigurations - 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.

DescribeIndexResponse, describeIndexResponse_edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.

DescribeIndexResponse, describeIndexResponse_errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

DescribeIndex, describeIndexResponse_id - The identifier of the index.

$sel:indexStatistics:DescribeIndexResponse', describeIndexResponse_indexStatistics - Provides information about the number of FAQ questions and answers and the number of text documents indexed.

DescribeIndexResponse, describeIndexResponse_name - The name of the index.

DescribeIndexResponse, describeIndexResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

$sel:serverSideEncryptionConfiguration:DescribeIndexResponse', describeIndexResponse_serverSideEncryptionConfiguration - The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

DescribeIndexResponse, describeIndexResponse_status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

DescribeIndexResponse, describeIndexResponse_updatedAt - The Unix datetime that the index was last updated.

$sel:userContextPolicy:DescribeIndexResponse', describeIndexResponse_userContextPolicy - The user context policy for the Amazon Kendra index.

$sel:userGroupResolutionConfiguration:DescribeIndexResponse', describeIndexResponse_userGroupResolutionConfiguration - Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.

$sel:userTokenConfigurations:DescribeIndexResponse', describeIndexResponse_userTokenConfigurations - The user token configuration for the Amazon Kendra index.

$sel:httpStatus:DescribeIndexResponse', describeIndexResponse_httpStatus - The response's http status code.

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 Adjusting capacity.

The Unix datetime that the index was created.

The description for the index.

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.

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

The identifier of the index.

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

The name of the index.

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

The Unix datetime that the index was last updated.

The user context policy for the Amazon Kendra index.

Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.

The user token configuration for the Amazon Kendra index.

The response's http status code.