Skip to content

Paginators#

Index > RedshiftDataAPIService > Paginators

Auto-generated documentation for RedshiftDataAPIService type annotations stubs module mypy-boto3-redshift-data.

DescribeTablePaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("describe_table"). boto3 documentation

# DescribeTablePaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import DescribeTablePaginator

def get_describe_table_paginator() -> DescribeTablePaginator:
    return Session().client("redshift-data").get_paginator("describe_table")
# DescribeTablePaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import DescribeTablePaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: DescribeTablePaginator = client.get_paginator("describe_table")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: DescribeTablePaginator
  3. item: DescribeTableResponseTypeDef

paginate#

Type annotations and code completion for DescribeTablePaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Database: str,
    ClusterIdentifier: str = ...,
    ConnectedDatabase: str = ...,
    DbUser: str = ...,
    Schema: str = ...,
    SecretArn: str = ...,
    Table: str = ...,
    WorkgroupName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeTableResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeTableResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeTableRequestPaginateTypeDef = {  # (1)
    "Database": ...,
}

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

GetStatementResultPaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("get_statement_result"). boto3 documentation

# GetStatementResultPaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import GetStatementResultPaginator

def get_get_statement_result_paginator() -> GetStatementResultPaginator:
    return Session().client("redshift-data").get_paginator("get_statement_result")
# GetStatementResultPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import GetStatementResultPaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: GetStatementResultPaginator = client.get_paginator("get_statement_result")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: GetStatementResultPaginator
  3. item: GetStatementResultResponseTypeDef

paginate#

Type annotations and code completion for GetStatementResultPaginator.paginate method.

# paginate method definition

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

kwargs: GetStatementResultRequestPaginateTypeDef = {  # (1)
    "Id": ...,
}

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

GetStatementResultV2Paginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("get_statement_result_v2"). boto3 documentation

# GetStatementResultV2Paginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import GetStatementResultV2Paginator

def get_get_statement_result_v2_paginator() -> GetStatementResultV2Paginator:
    return Session().client("redshift-data").get_paginator("get_statement_result_v2")
# GetStatementResultV2Paginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import GetStatementResultV2Paginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: GetStatementResultV2Paginator = client.get_paginator("get_statement_result_v2")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: GetStatementResultV2Paginator
  3. item: GetStatementResultV2ResponseTypeDef

paginate#

Type annotations and code completion for GetStatementResultV2Paginator.paginate method.

# paginate method definition

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

kwargs: GetStatementResultV2RequestPaginateTypeDef = {  # (1)
    "Id": ...,
}

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

ListDatabasesPaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("list_databases"). boto3 documentation

# ListDatabasesPaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListDatabasesPaginator

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

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListDatabasesPaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: ListDatabasesPaginator = client.get_paginator("list_databases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: ListDatabasesPaginator
  3. item: ListDatabasesResponseTypeDef

paginate#

Type annotations and code completion for ListDatabasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Database: str,
    ClusterIdentifier: str = ...,
    DbUser: str = ...,
    SecretArn: str = ...,
    WorkgroupName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListDatabasesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListDatabasesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListDatabasesRequestPaginateTypeDef = {  # (1)
    "Database": ...,
}

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

ListSchemasPaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("list_schemas"). boto3 documentation

# ListSchemasPaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListSchemasPaginator

def get_list_schemas_paginator() -> ListSchemasPaginator:
    return Session().client("redshift-data").get_paginator("list_schemas")
# ListSchemasPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListSchemasPaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: ListSchemasPaginator = client.get_paginator("list_schemas")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: ListSchemasPaginator
  3. item: ListSchemasResponseTypeDef

paginate#

Type annotations and code completion for ListSchemasPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Database: str,
    ClusterIdentifier: str = ...,
    ConnectedDatabase: str = ...,
    DbUser: str = ...,
    SchemaPattern: str = ...,
    SecretArn: str = ...,
    WorkgroupName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListSchemasResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListSchemasResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListSchemasRequestPaginateTypeDef = {  # (1)
    "Database": ...,
}

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

ListStatementsPaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("list_statements"). boto3 documentation

# ListStatementsPaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListStatementsPaginator

def get_list_statements_paginator() -> ListStatementsPaginator:
    return Session().client("redshift-data").get_paginator("list_statements")
# ListStatementsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListStatementsPaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: ListStatementsPaginator = client.get_paginator("list_statements")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: ListStatementsPaginator
  3. item: ListStatementsResponseTypeDef

paginate#

Type annotations and code completion for ListStatementsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    RoleLevel: bool = ...,
    StatementName: str = ...,
    Status: StatusStringType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListStatementsResponseTypeDef]:  # (3)
    ...
  1. See StatusStringType
  2. See PaginatorConfigTypeDef
  3. See ListStatementsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListStatementsRequestPaginateTypeDef = {  # (1)
    "RoleLevel": ...,
}

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

ListTablesPaginator#

Type annotations and code completion for boto3.client("redshift-data").get_paginator("list_tables"). boto3 documentation

# ListTablesPaginator usage example

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListTablesPaginator

def get_list_tables_paginator() -> ListTablesPaginator:
    return Session().client("redshift-data").get_paginator("list_tables")
# ListTablesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_redshift_data.paginator import ListTablesPaginator

session = Session()

client = Session().client("redshift-data")  # (1)
paginator: ListTablesPaginator = client.get_paginator("list_tables")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: RedshiftDataAPIServiceClient
  2. paginator: ListTablesPaginator
  3. item: ListTablesResponseTypeDef

paginate#

Type annotations and code completion for ListTablesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Database: str,
    ClusterIdentifier: str = ...,
    ConnectedDatabase: str = ...,
    DbUser: str = ...,
    SchemaPattern: str = ...,
    SecretArn: str = ...,
    TablePattern: str = ...,
    WorkgroupName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListTablesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListTablesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListTablesRequestPaginateTypeDef = {  # (1)
    "Database": ...,
}

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