CreateIndexRequest ¶

class CreateIndexRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application using the index.</p>"""
    display_name: "capo_qbusiness.types.index_name.IndexName"
    """<p>A name for the Amazon Q Business index.</p>"""
    description: NotRequired["capo_qbusiness.types.description.Description"]
    """<p>A description for the Amazon Q Business index.</p>"""
    type: NotRequired["capo_qbusiness.types.index_type.IndexType"]
    """<p>The index type that's suitable for your needs. For more information on what's included in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business tiers</a>.</p>"""
    tags: NotRequired["capo_qbusiness.types.tags.Tags"]
    """<p>A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>"""
    capacity_configuration: NotRequired[
        "capo_qbusiness.types.index_capacity_configuration.IndexCapacityConfiguration"
    ]
    """<p>The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the request to create an index. Multiple calls to the <code>CreateIndex</code> API with the same client token will create only one index.</p>"""