Athena / Paginator / ListNamedQueries

ListNamedQueries#

class Athena.Paginator.ListNamedQueries#

paginator = client.get_paginator('list_named_queries')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

WorkGroup (string) – The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
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

{
    'NamedQueryIds': [
        'string',
    ],

}

Response Structure

(dict) –
- NamedQueryIds (list) –
  
  The list of unique query IDs.
  - (string) –