Skip to content

/AWS1/CL_ATH=>GETQUERYRESULTS()

About GetQueryResults

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

Method Signature

IMPORTING

Required arguments:

iv_queryexecutionid TYPE /AWS1/ATHQUERYEXECUTIONID /AWS1/ATHQUERYEXECUTIONID

The unique ID of the query execution.

Optional arguments:

iv_nexttoken TYPE /AWS1/ATHTOKEN /AWS1/ATHTOKEN

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.

iv_maxresults TYPE /AWS1/ATHMAXQUERYRESULTS /AWS1/ATHMAXQUERYRESULTS

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

RETURNING

oo_output TYPE REF TO /aws1/cl_athgetqueryrsltsout /AWS1/CL_ATHGETQUERYRSLTSOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_ath~getqueryresults(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_queryexecutionid = |string|
).

This is an example of reading all possible response values

lv_long = lo_result->get_updatecount( ).
LOOP AT lo_resultset->get_rows( ) into lo_row.
  LOOP AT lo_row_1->get_data( ) into lo_row_2.
    lv_datumstring = lo_row_3->get_varcharvalue( ).
  ENDLOOP.
ENDLOOP.
LOOP AT lo_resultsetmetadata->get_columninfo( ) into lo_row_4.
  lv_string = lo_row_5->get_catalogname( ).
  lv_string = lo_row_5->get_schemaname( ).
  lv_string = lo_row_5->get_tablename( ).
  lv_string = lo_row_5->get_name( ).
  lv_string = lo_row_5->get_label( ).
  lv_string = lo_row_5->get_type( ).
  lv_integer = lo_row_5->get_precision( ).
  lv_integer = lo_row_5->get_scale( ).
  lv_columnnullable = lo_row_5->get_nullable( ).
  lv_boolean = lo_row_5->get_casesensitive( ).
ENDLOOP.
lv_token = lo_result->get_nexttoken( ).