Skip to content

QueryExecution

Source code in docs_src/capo_athena/types/query_execution.py
class QueryExecution(TypedDict, closed=True):
    query_execution_id: NotRequired[
        "capo_athena.types.query_execution_id.QueryExecutionId"
    ]
    """<p>The unique identifier for each query execution.</p>"""
    query: NotRequired["capo_athena.types.query_string.QueryString"]
    """<p>The SQL query statements which the query execution ran.</p>"""
    statement_type: NotRequired["capo_athena.types.statement_type.StatementType"]
    """<p>The type of query statement that was run. <code>DDL</code> indicates DDL query statements. <code>DML</code> indicates DML (Data Manipulation Language) query statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, <code>EXPLAIN</code>, <code>DESCRIBE</code>, or <code>SHOW TABLES</code>.</p>"""
    managed_query_results_configuration: NotRequired[
        "capo_athena.types.managed_query_results_configuration.ManagedQueryResultsConfiguration"
    ]
    """<p> The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results. </p>"""
    result_configuration: NotRequired[
        "capo_athena.types.result_configuration.ResultConfiguration"
    ]
    """<p>The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>"""
    result_reuse_configuration: NotRequired[
        "capo_athena.types.result_reuse_configuration.ResultReuseConfiguration"
    ]
    """<p>Specifies the query result reuse behavior that was used for the query.</p>"""
    query_execution_context: NotRequired[
        "capo_athena.types.query_execution_context.QueryExecutionContext"
    ]
    """<p>The database in which the query execution occurred.</p>"""
    status: NotRequired["capo_athena.types.query_execution_status.QueryExecutionStatus"]
    """<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"""
    statistics: NotRequired[
        "capo_athena.types.query_execution_statistics.QueryExecutionStatistics"
    ]
    """<p>Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.</p>"""
    work_group: NotRequired["capo_athena.types.work_group_name.WorkGroupName"]
    """<p>The name of the workgroup in which the query ran.</p>"""
    engine_version: NotRequired["capo_athena.types.engine_version.EngineVersion"]
    """<p>The engine version that executed the query.</p>"""
    execution_parameters: NotRequired[
        "capo_athena.types.execution_parameters.ExecutionParameters"
    ]
    """<p>A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.</p>"""
    substatement_type: NotRequired["capo_athena.types.string.String"]
    """<p>The kind of query statement that was run.</p>"""
    query_results_s3_access_grants_configuration: NotRequired[
        "capo_athena.types.query_results_s3_access_grants_configuration.QueryResultsS3AccessGrantsConfiguration"
    ]
    """<p>Specifies whether Amazon S3 access grants are enabled for query results.</p>"""

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

The engine version that executed the query.

execution_parameters instance-attribute

execution_parameters: NotRequired[ExecutionParameters]

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

managed_query_results_configuration instance-attribute

managed_query_results_configuration: NotRequired[ManagedQueryResultsConfiguration]

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

query instance-attribute

query: NotRequired[QueryString]

The SQL query statements which the query execution ran.

query_execution_context instance-attribute

query_execution_context: NotRequired[QueryExecutionContext]

The database in which the query execution occurred.

query_execution_id instance-attribute

query_execution_id: NotRequired[QueryExecutionId]

The unique identifier for each query execution.

query_results_s3_access_grants_configuration instance-attribute

query_results_s3_access_grants_configuration: NotRequired[
    QueryResultsS3AccessGrantsConfiguration
]

Specifies whether Amazon S3 access grants are enabled for query results.

result_configuration instance-attribute

result_configuration: NotRequired[ResultConfiguration]

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

result_reuse_configuration instance-attribute

result_reuse_configuration: NotRequired[ResultReuseConfiguration]

Specifies the query result reuse behavior that was used for the query.

statement_type instance-attribute

statement_type: NotRequired[StatementType]

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, EXPLAIN, DESCRIBE, or SHOW TABLES.

statistics instance-attribute

statistics: NotRequired[QueryExecutionStatistics]

Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

status instance-attribute

status: NotRequired[QueryExecutionStatus]

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

substatement_type instance-attribute

substatement_type: NotRequired[String]

The kind of query statement that was run.

work_group instance-attribute

work_group: NotRequired[WorkGroupName]

The name of the workgroup in which the query ran.