GetIndexResponse ¶

class GetIndexResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application associated with the index.</p>"""
    index_id: NotRequired["capo_qbusiness.types.index_id.IndexId"]
    """<p>The identifier of the Amazon Q Business index.</p>"""
    display_name: NotRequired["capo_qbusiness.types.index_name.IndexName"]
    """<p>The name of the Amazon Q Business index.</p>"""
    index_arn: NotRequired["capo_qbusiness.types.index_arn.IndexArn"]
    """<p> The Amazon Resource Name (ARN) of the Amazon Q Business index. </p>"""
    status: NotRequired["capo_qbusiness.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>"""
    type: NotRequired["capo_qbusiness.types.index_type.IndexType"]
    """<p>The type of index attached to your Amazon Q Business application.</p>"""
    description: NotRequired["capo_qbusiness.types.description.Description"]
    """<p>The description for the Amazon Q Business index.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business index was created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business index was last updated.</p>"""
    capacity_configuration: NotRequired[
        "capo_qbusiness.types.index_capacity_configuration.IndexCapacityConfiguration"
    ]
    """<p>The storage capacity units chosen for your Amazon Q Business index.</p>"""
    document_attribute_configurations: NotRequired[
        "capo_qbusiness.types.document_attribute_configurations.DocumentAttributeConfigurations"
    ]
    """<p>Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>"""
    index_statistics: NotRequired[
        "capo_qbusiness.types.index_statistics.IndexStatistics"
    ]
    """<p>Provides information about the number of documents indexed.</p>"""