DescribeIndexResponse ¶

class DescribeIndexResponse(TypedDict, closed=True):
    name: NotRequired["capo_kendra.types.index_name.IndexName"]
    """<p>The name of the index.</p>"""
    id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>The identifier of the index.</p>"""
    edition: NotRequired["capo_kendra.types.index_edition.IndexEdition"]
    """<p>The Amazon Kendra edition used for the index. You decide the edition when you create the index.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<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: NotRequired[
        "capo_kendra.types.server_side_encryption_configuration.ServerSideEncryptionConfiguration"
    ]
    """<p>The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.</p>"""
    status: NotRequired["capo_kendra.types.index_status.IndexStatus"]
    """<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: NotRequired["capo_kendra.types.description.Description"]
    """<p>The description for the index.</p>"""
    created_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the index was created.</p>"""
    updated_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the index was last updated.</p>"""
    document_metadata_configurations: NotRequired[
        "capo_kendra.types.document_metadata_configuration_list.DocumentMetadataConfigurationList"
    ]
    """<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: NotRequired["capo_kendra.types.index_statistics.IndexStatistics"]
    """<p>Provides information about the number of FAQ questions and answers and the number of text documents indexed.</p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<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: NotRequired[
        "capo_kendra.types.capacity_units_configuration.CapacityUnitsConfiguration"
    ]
    """<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: NotRequired[
        "capo_kendra.types.user_token_configuration_list.UserTokenConfigurationList"
    ]
    """<p>The user token configuration for the Amazon Kendra index.</p>"""
    user_context_policy: NotRequired[
        "capo_kendra.types.user_context_policy.UserContextPolicy"
    ]
    """<p>The user context policy for the Amazon Kendra index.</p>"""
    user_group_resolution_configuration: NotRequired[
        "capo_kendra.types.user_group_resolution_configuration.UserGroupResolutionConfiguration"
    ]
    """<p>Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>"""