Skip to content

GetQueryResultsInput

Source code in docs_src/capo_athena/types/get_query_results_input.py
class GetQueryResultsInput(TypedDict, closed=True):
    query_execution_id: "capo_athena.types.query_execution_id.QueryExecutionId"
    """<p>The unique ID of the query execution.</p>"""
    next_token: NotRequired["capo_athena.types.token.Token"]
    """<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"""
    max_results: NotRequired["capo_athena.types.max_query_results.MaxQueryResults"]
    """<p>The maximum number of results (rows) to return in this request.</p>"""
    query_result_type: NotRequired[
        "capo_athena.types.query_result_type.QueryResultType"
    ]
    """<p> When you set this to <code>DATA_ROWS</code> or empty, <code>GetQueryResults</code> returns the query results in rows. If set to <code>DATA_MANIFEST</code>, it returns the manifest file in rows. Only the query types <code>CREATE TABLE AS SELECT</code>, <code>UNLOAD</code>, and <code>INSERT</code> can generate a manifest file. If you use <code>DATA_MANIFEST</code> for other query types, the query will fail. </p>"""

max_results instance-attribute

max_results: NotRequired[MaxQueryResults]

The maximum number of results (rows) to return in this request.

next_token instance-attribute

next_token: NotRequired[Token]

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

query_execution_id instance-attribute

query_execution_id: QueryExecutionId

The unique ID of the query execution.

query_result_type instance-attribute

query_result_type: NotRequired[QueryResultType]

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.