Skip to content

Paginators#

Index > Athena > Paginators

Auto-generated documentation for Athena type annotations stubs module types-boto3-athena.

GetQueryResultsPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("get_query_results"). boto3 documentation

# GetQueryResultsPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import GetQueryResultsPaginator

def get_get_query_results_paginator() -> GetQueryResultsPaginator:
    return Session().client("athena").get_paginator("get_query_results")
# GetQueryResultsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import GetQueryResultsPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: GetQueryResultsPaginator = client.get_paginator("get_query_results")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: GetQueryResultsPaginator
  3. item: PageIterator[GetQueryResultsOutputTypeDef]

paginate#

Type annotations and code completion for GetQueryResultsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    QueryExecutionId: str,
    QueryResultType: QueryResultTypeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[GetQueryResultsOutputTypeDef]:  # (3)
    ...
  1. See QueryResultTypeType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[GetQueryResultsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetQueryResultsInputPaginateTypeDef = {  # (1)
    "QueryExecutionId": ...,
}

parent.paginate(**kwargs)
  1. See GetQueryResultsInputPaginateTypeDef

ListDataCatalogsPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_data_catalogs"). boto3 documentation

# ListDataCatalogsPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListDataCatalogsPaginator

def get_list_data_catalogs_paginator() -> ListDataCatalogsPaginator:
    return Session().client("athena").get_paginator("list_data_catalogs")
# ListDataCatalogsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListDataCatalogsPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListDataCatalogsPaginator = client.get_paginator("list_data_catalogs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListDataCatalogsPaginator
  3. item: PageIterator[ListDataCatalogsOutputTypeDef]

paginate#

Type annotations and code completion for ListDataCatalogsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    WorkGroup: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListDataCatalogsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListDataCatalogsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListDataCatalogsInputPaginateTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.paginate(**kwargs)
  1. See ListDataCatalogsInputPaginateTypeDef

ListDatabasesPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_databases"). boto3 documentation

# ListDatabasesPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListDatabasesPaginator

def get_list_databases_paginator() -> ListDatabasesPaginator:
    return Session().client("athena").get_paginator("list_databases")
# ListDatabasesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListDatabasesPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListDatabasesPaginator = client.get_paginator("list_databases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListDatabasesPaginator
  3. item: PageIterator[ListDatabasesOutputTypeDef]

paginate#

Type annotations and code completion for ListDatabasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    CatalogName: str,
    WorkGroup: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListDatabasesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListDatabasesOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListDatabasesInputPaginateTypeDef = {  # (1)
    "CatalogName": ...,
}

parent.paginate(**kwargs)
  1. See ListDatabasesInputPaginateTypeDef

ListNamedQueriesPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_named_queries"). boto3 documentation

# ListNamedQueriesPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListNamedQueriesPaginator

def get_list_named_queries_paginator() -> ListNamedQueriesPaginator:
    return Session().client("athena").get_paginator("list_named_queries")
# ListNamedQueriesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListNamedQueriesPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListNamedQueriesPaginator = client.get_paginator("list_named_queries")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListNamedQueriesPaginator
  3. item: PageIterator[ListNamedQueriesOutputTypeDef]

paginate#

Type annotations and code completion for ListNamedQueriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    WorkGroup: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListNamedQueriesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListNamedQueriesOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListNamedQueriesInputPaginateTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.paginate(**kwargs)
  1. See ListNamedQueriesInputPaginateTypeDef

ListQueryExecutionsPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_query_executions"). boto3 documentation

# ListQueryExecutionsPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListQueryExecutionsPaginator

def get_list_query_executions_paginator() -> ListQueryExecutionsPaginator:
    return Session().client("athena").get_paginator("list_query_executions")
# ListQueryExecutionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListQueryExecutionsPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListQueryExecutionsPaginator = client.get_paginator("list_query_executions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListQueryExecutionsPaginator
  3. item: PageIterator[ListQueryExecutionsOutputTypeDef]

paginate#

Type annotations and code completion for ListQueryExecutionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    WorkGroup: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListQueryExecutionsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListQueryExecutionsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListQueryExecutionsInputPaginateTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.paginate(**kwargs)
  1. See ListQueryExecutionsInputPaginateTypeDef

ListTableMetadataPaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_table_metadata"). boto3 documentation

# ListTableMetadataPaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListTableMetadataPaginator

def get_list_table_metadata_paginator() -> ListTableMetadataPaginator:
    return Session().client("athena").get_paginator("list_table_metadata")
# ListTableMetadataPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListTableMetadataPaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListTableMetadataPaginator = client.get_paginator("list_table_metadata")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListTableMetadataPaginator
  3. item: PageIterator[ListTableMetadataOutputTypeDef]

paginate#

Type annotations and code completion for ListTableMetadataPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    CatalogName: str,
    DatabaseName: str,
    Expression: str = ...,
    WorkGroup: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListTableMetadataOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListTableMetadataOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListTableMetadataInputPaginateTypeDef = {  # (1)
    "CatalogName": ...,
    "DatabaseName": ...,
}

parent.paginate(**kwargs)
  1. See ListTableMetadataInputPaginateTypeDef

ListTagsForResourcePaginator#

Type annotations and code completion for boto3.client("athena").get_paginator("list_tags_for_resource"). boto3 documentation

# ListTagsForResourcePaginator usage example

from boto3.session import Session

from types_boto3_athena.paginator import ListTagsForResourcePaginator

def get_list_tags_for_resource_paginator() -> ListTagsForResourcePaginator:
    return Session().client("athena").get_paginator("list_tags_for_resource")
# ListTagsForResourcePaginator usage example with type annotations

from boto3.session import Session

from types_boto3_athena.paginator import ListTagsForResourcePaginator

session = Session()

client = Session().client("athena")  # (1)
paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AthenaClient
  2. paginator: ListTagsForResourcePaginator
  3. item: PageIterator[ListTagsForResourceOutputTypeDef]

paginate#

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ResourceARN: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListTagsForResourceOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListTagsForResourceOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListTagsForResourceInputPaginateTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.paginate(**kwargs)
  1. See ListTagsForResourceInputPaginateTypeDef