Paginators

Index > SFN > Paginators

Auto-generated documentation for SFN type annotations stubs module types-aiobotocore-stepfunctions.

GetExecutionHistoryPaginator

Type annotations and code completion for session.create_client("stepfunctions").get_paginator("get_execution_history"). boto3 documentation

# GetExecutionHistoryPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.paginator import GetExecutionHistoryPaginator

session = get_session()
async with session.create_client("stepfunctions") as client:  # (1)
    paginator: GetExecutionHistoryPaginator = client.get_paginator("get_execution_history")  # (2)
    async for item in paginator.paginate(...):
        item: GetExecutionHistoryOutputTypeDef
        print(item)  # (3)

1. client: SFNClient
2. paginator: GetExecutionHistoryPaginator
3. item: GetExecutionHistoryOutputTypeDef

paginate

Type annotations and code completion for GetExecutionHistoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    executionArn: str,
    reverseOrder: bool = ...,
    includeExecutionData: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[GetExecutionHistoryOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See GetExecutionHistoryOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef = {  # (1)
    "executionArn": ...,
}

parent.paginate(**kwargs)

1. See GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef

ListActivitiesPaginator

Type annotations and code completion for session.create_client("stepfunctions").get_paginator("list_activities"). boto3 documentation

# ListActivitiesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.paginator import ListActivitiesPaginator

session = get_session()
async with session.create_client("stepfunctions") as client:  # (1)
    paginator: ListActivitiesPaginator = client.get_paginator("list_activities")  # (2)
    async for item in paginator.paginate(...):
        item: ListActivitiesOutputTypeDef
        print(item)  # (3)

1. client: SFNClient
2. paginator: ListActivitiesPaginator
3. item: ListActivitiesOutputTypeDef

paginate

Type annotations and code completion for ListActivitiesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListActivitiesOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListActivitiesInputListActivitiesPaginateTypeDef

ListExecutionsPaginator

Type annotations and code completion for session.create_client("stepfunctions").get_paginator("list_executions"). boto3 documentation

# ListExecutionsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.paginator import ListExecutionsPaginator

session = get_session()
async with session.create_client("stepfunctions") as client:  # (1)
    paginator: ListExecutionsPaginator = client.get_paginator("list_executions")  # (2)
    async for item in paginator.paginate(...):
        item: ListExecutionsOutputTypeDef
        print(item)  # (3)

1. client: SFNClient
2. paginator: ListExecutionsPaginator
3. item: ListExecutionsOutputTypeDef

paginate

Type annotations and code completion for ListExecutionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    stateMachineArn: str = ...,
    statusFilter: ExecutionStatusType = ...,  # (1)
    mapRunArn: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListExecutionsOutputTypeDef]:  # (3)
    ...

1. See ExecutionStatusType
2. See PaginatorConfigTypeDef
3. See ListExecutionsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListExecutionsInputListExecutionsPaginateTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.paginate(**kwargs)

1. See ListExecutionsInputListExecutionsPaginateTypeDef

ListMapRunsPaginator

Type annotations and code completion for session.create_client("stepfunctions").get_paginator("list_map_runs"). boto3 documentation

# ListMapRunsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.paginator import ListMapRunsPaginator

session = get_session()
async with session.create_client("stepfunctions") as client:  # (1)
    paginator: ListMapRunsPaginator = client.get_paginator("list_map_runs")  # (2)
    async for item in paginator.paginate(...):
        item: ListMapRunsOutputTypeDef
        print(item)  # (3)

1. client: SFNClient
2. paginator: ListMapRunsPaginator
3. item: ListMapRunsOutputTypeDef

paginate

Type annotations and code completion for ListMapRunsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    executionArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListMapRunsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListMapRunsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListMapRunsInputListMapRunsPaginateTypeDef = {  # (1)
    "executionArn": ...,
}

parent.paginate(**kwargs)

1. See ListMapRunsInputListMapRunsPaginateTypeDef

ListStateMachinesPaginator

Type annotations and code completion for session.create_client("stepfunctions").get_paginator("list_state_machines"). boto3 documentation

# ListStateMachinesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.paginator import ListStateMachinesPaginator

session = get_session()
async with session.create_client("stepfunctions") as client:  # (1)
    paginator: ListStateMachinesPaginator = client.get_paginator("list_state_machines")  # (2)
    async for item in paginator.paginate(...):
        item: ListStateMachinesOutputTypeDef
        print(item)  # (3)

1. client: SFNClient
2. paginator: ListStateMachinesPaginator
3. item: ListStateMachinesOutputTypeDef

paginate

Type annotations and code completion for ListStateMachinesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListStateMachinesOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListStateMachinesInputListStateMachinesPaginateTypeDef