Athena / Paginator / GetQueryResults

GetQueryResults

class Athena.Paginator.GetQueryResults

paginator = client.get_paginator('get_query_results')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Athena.Client.get_query_results().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    QueryExecutionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• QueryExecutionId (string) –

  [REQUIRED]

  The unique ID of the query execution.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'UpdateCount': 123,
    'ResultSet': {
        'Rows': [
            {
                'Data': [
                    {
                        'VarCharValue': 'string'
                    },
                ]
            },
        ],
        'ResultSetMetadata': {
            'ColumnInfo': [
                {
                    'CatalogName': 'string',
                    'SchemaName': 'string',
                    'TableName': 'string',
                    'Name': 'string',
                    'Label': 'string',
                    'Type': 'string',
                    'Precision': 123,
                    'Scale': 123,
                    'Nullable': 'NOT_NULL'|'NULLABLE'|'UNKNOWN',
                    'CaseSensitive': True|False
                },
            ]
        }
    },

}

Response Structure

• (dict) –

  • UpdateCount (integer) –

    The number of rows inserted with a CREATE TABLE AS SELECT statement.

  • ResultSet (dict) –

    The results of the query execution.

    • Rows (list) –

      The rows in the table.

      • (dict) –

        The rows that make up a query result table.

        • Data (list) –

          The data that populates a row in a query result table.

          • (dict) –

            A piece of data (a field in the table).

            • VarCharValue (string) –

              The value of the datum.

    • ResultSetMetadata (dict) –

      The metadata that describes the column structure and data types of a table of query results.

      • ColumnInfo (list) –

        Information about the columns returned in a query result metadata.

        • (dict) –

          Information about the columns in a query execution result.

          • CatalogName (string) –

            The catalog to which the query results belong.

          • SchemaName (string) –

            The schema name (database name) to which the query results belong.

          • TableName (string) –

            The table name for the query results.

          • Name (string) –

            The name of the column.

          • Label (string) –

            A column label.

          • Type (string) –

            The data type of the column.

          • Precision (integer) –

            For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

          • Scale (integer) –

            For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

          • Nullable (string) –

            Indicates the column’s nullable status.

          • CaseSensitive (boolean) –

            Indicates whether values in the column are case-sensitive.