Skip to content

QueryGenerationColumn

Source code in docs_src/capo_bedrock_agent/types/query_generation_column.py
class QueryGenerationColumn(TypedDict, closed=True):
    name: NotRequired[
        "capo_bedrock_agent.types.query_generation_column_name.QueryGenerationColumnName"
    ]
    """<p>The name of the column for which the other fields in this object apply.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.description_string.DescriptionString"
    ]
    """<p>A description of the column that helps the query engine understand the contents of the column.</p>"""
    inclusion: NotRequired["capo_bedrock_agent.types.include_exclude.IncludeExclude"]
    """<p>Specifies whether to include or exclude the column during query generation. If you specify <code>EXCLUDE</code>, the column will be ignored. If you specify <code>INCLUDE</code>, all other columns in the table will be ignored.</p>"""

description instance-attribute

description: NotRequired[DescriptionString]

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

inclusion instance-attribute

inclusion: NotRequired[IncludeExclude]

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

name instance-attribute

name: NotRequired[QueryGenerationColumnName]

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