Paginators

Index > DataPipeline > Paginators

Auto-generated documentation for DataPipeline type annotations stubs module types-boto3-datapipeline.

DescribeObjectsPaginator

Type annotations and code completion for boto3.client("datapipeline").get_paginator("describe_objects"). boto3 documentation

# DescribeObjectsPaginator usage example

from boto3.session import Session

from types_boto3_datapipeline.paginator import DescribeObjectsPaginator

def get_describe_objects_paginator() -> DescribeObjectsPaginator:
    return Session().client("datapipeline").get_paginator("describe_objects")

# DescribeObjectsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datapipeline.paginator import DescribeObjectsPaginator

session = Session()

client = Session().client("datapipeline")  # (1)
paginator: DescribeObjectsPaginator = client.get_paginator("describe_objects")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataPipelineClient
2. paginator: DescribeObjectsPaginator
3. item: DescribeObjectsOutputTypeDef

paginate

Type annotations and code completion for DescribeObjectsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    pipelineId: str,
    objectIds: Sequence[str],
    evaluateExpressions: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeObjectsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeObjectsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeObjectsInputPaginateTypeDef = {  # (1)
    "pipelineId": ...,
    "objectIds": ...,
}

parent.paginate(**kwargs)

1. See DescribeObjectsInputPaginateTypeDef

ListPipelinesPaginator

Type annotations and code completion for boto3.client("datapipeline").get_paginator("list_pipelines"). boto3 documentation

# ListPipelinesPaginator usage example

from boto3.session import Session

from types_boto3_datapipeline.paginator import ListPipelinesPaginator

def get_list_pipelines_paginator() -> ListPipelinesPaginator:
    return Session().client("datapipeline").get_paginator("list_pipelines")

# ListPipelinesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datapipeline.paginator import ListPipelinesPaginator

session = Session()

client = Session().client("datapipeline")  # (1)
paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataPipelineClient
2. paginator: ListPipelinesPaginator
3. item: ListPipelinesOutputTypeDef

paginate

Type annotations and code completion for ListPipelinesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListPipelinesOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListPipelinesOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListPipelinesInputPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListPipelinesInputPaginateTypeDef

QueryObjectsPaginator

Type annotations and code completion for boto3.client("datapipeline").get_paginator("query_objects"). boto3 documentation

# QueryObjectsPaginator usage example

from boto3.session import Session

from types_boto3_datapipeline.paginator import QueryObjectsPaginator

def get_query_objects_paginator() -> QueryObjectsPaginator:
    return Session().client("datapipeline").get_paginator("query_objects")

# QueryObjectsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datapipeline.paginator import QueryObjectsPaginator

session = Session()

client = Session().client("datapipeline")  # (1)
paginator: QueryObjectsPaginator = client.get_paginator("query_objects")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataPipelineClient
2. paginator: QueryObjectsPaginator
3. item: QueryObjectsOutputTypeDef

paginate

Type annotations and code completion for QueryObjectsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    pipelineId: str,
    sphere: str,
    query: QueryTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[QueryObjectsOutputTypeDef]:  # (3)
    ...

1. See QueryTypeDef
2. See PaginatorConfigTypeDef
3. See QueryObjectsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: QueryObjectsInputPaginateTypeDef = {  # (1)
    "pipelineId": ...,
    "sphere": ...,
}

parent.paginate(**kwargs)

1. See QueryObjectsInputPaginateTypeDef