Skip to content

QueryGenerationTable

Source code in docs_src/capo_bedrock_agent/types/query_generation_table.py
class QueryGenerationTable(TypedDict, closed=True):
    name: (
        "capo_bedrock_agent.types.query_generation_table_name.QueryGenerationTableName"
    )
    """<p>The name of the table for which the other fields in this object apply.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.description_string.DescriptionString"
    ]
    """<p>A description of the table that helps the query engine understand the contents of the table.</p>"""
    inclusion: NotRequired["capo_bedrock_agent.types.include_exclude.IncludeExclude"]
    """<p>Specifies whether to include or exclude the table during query generation. If you specify <code>EXCLUDE</code>, the table will be ignored. If you specify <code>INCLUDE</code>, all other tables will be ignored.</p>"""
    columns: NotRequired[
        "capo_bedrock_agent.types.query_generation_columns.QueryGenerationColumns"
    ]
    """<p>An array of objects, each of which defines information about a column in the table.</p>"""

columns instance-attribute

columns: NotRequired[QueryGenerationColumns]

An array of objects, each of which defines information about a column in the table.

description instance-attribute

description: NotRequired[DescriptionString]

A description of the table that helps the query engine understand the contents of the table.

inclusion instance-attribute

inclusion: NotRequired[IncludeExclude]

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

name instance-attribute

The name of the table for which the other fields in this object apply.