Paginators

Index > SWF > Paginators

Auto-generated documentation for SWF type annotations stubs module mypy-boto3-swf.

GetWorkflowExecutionHistoryPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("get_workflow_execution_history"). boto3 documentation

# GetWorkflowExecutionHistoryPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import GetWorkflowExecutionHistoryPaginator

def get_get_workflow_execution_history_paginator() -> GetWorkflowExecutionHistoryPaginator:
    return Session().client("swf").get_paginator("get_workflow_execution_history")

# GetWorkflowExecutionHistoryPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import GetWorkflowExecutionHistoryPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: GetWorkflowExecutionHistoryPaginator = client.get_paginator("get_workflow_execution_history")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: GetWorkflowExecutionHistoryPaginator
3. item: PageIterator[HistoryTypeDef]

paginate

Type annotations and code completion for GetWorkflowExecutionHistoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    execution: WorkflowExecutionTypeDef,  # (1)
    reverseOrder: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[HistoryTypeDef]:  # (3)
    ...

1. See WorkflowExecutionTypeDef
2. See PaginatorConfigTypeDef
3. See PageIterator[HistoryTypeDef]

# paginate method usage example with argument unpacking

kwargs: GetWorkflowExecutionHistoryInputPaginateTypeDef = {  # (1)
    "domain": ...,
    "execution": ...,
}

parent.paginate(**kwargs)

1. See GetWorkflowExecutionHistoryInputPaginateTypeDef

ListActivityTypesPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("list_activity_types"). boto3 documentation

# ListActivityTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import ListActivityTypesPaginator

def get_list_activity_types_paginator() -> ListActivityTypesPaginator:
    return Session().client("swf").get_paginator("list_activity_types")

# ListActivityTypesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import ListActivityTypesPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: ListActivityTypesPaginator = client.get_paginator("list_activity_types")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: ListActivityTypesPaginator
3. item: PageIterator[ActivityTypeInfosTypeDef]

paginate

Type annotations and code completion for ListActivityTypesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    registrationStatus: RegistrationStatusType,  # (1)
    name: str = ...,
    reverseOrder: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ActivityTypeInfosTypeDef]:  # (3)
    ...

1. See RegistrationStatusType
2. See PaginatorConfigTypeDef
3. See PageIterator[ActivityTypeInfosTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListActivityTypesInputPaginateTypeDef = {  # (1)
    "domain": ...,
    "registrationStatus": ...,
}

parent.paginate(**kwargs)

1. See ListActivityTypesInputPaginateTypeDef

ListClosedWorkflowExecutionsPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("list_closed_workflow_executions"). boto3 documentation

# ListClosedWorkflowExecutionsPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import ListClosedWorkflowExecutionsPaginator

def get_list_closed_workflow_executions_paginator() -> ListClosedWorkflowExecutionsPaginator:
    return Session().client("swf").get_paginator("list_closed_workflow_executions")

# ListClosedWorkflowExecutionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import ListClosedWorkflowExecutionsPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: ListClosedWorkflowExecutionsPaginator = client.get_paginator("list_closed_workflow_executions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: ListClosedWorkflowExecutionsPaginator
3. item: PageIterator[WorkflowExecutionInfosTypeDef]

paginate

Type annotations and code completion for ListClosedWorkflowExecutionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    closeTimeFilter: ExecutionTimeFilterTypeDef = ...,  # (1)
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (3)
    closeStatusFilter: CloseStatusFilterTypeDef = ...,  # (4)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (5)
    tagFilter: TagFilterTypeDef = ...,  # (6)
    reverseOrder: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (7)
) -> botocore.paginate.PageIterator[WorkflowExecutionInfosTypeDef]:  # (8)
    ...

1. See ExecutionTimeFilterTypeDef
2. See ExecutionTimeFilterTypeDef
3. See WorkflowExecutionFilterTypeDef
4. See CloseStatusFilterTypeDef
5. See WorkflowTypeFilterTypeDef
6. See TagFilterTypeDef
7. See PaginatorConfigTypeDef
8. See PageIterator[WorkflowExecutionInfosTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListClosedWorkflowExecutionsInputPaginateTypeDef = {  # (1)
    "domain": ...,
}

parent.paginate(**kwargs)

1. See ListClosedWorkflowExecutionsInputPaginateTypeDef

ListDomainsPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("list_domains"). boto3 documentation

# ListDomainsPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import ListDomainsPaginator

def get_list_domains_paginator() -> ListDomainsPaginator:
    return Session().client("swf").get_paginator("list_domains")

# ListDomainsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import ListDomainsPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: ListDomainsPaginator = client.get_paginator("list_domains")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: ListDomainsPaginator
3. item: PageIterator[DomainInfosTypeDef]

paginate

Type annotations and code completion for ListDomainsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    registrationStatus: RegistrationStatusType,  # (1)
    reverseOrder: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[DomainInfosTypeDef]:  # (3)
    ...

1. See RegistrationStatusType
2. See PaginatorConfigTypeDef
3. See PageIterator[DomainInfosTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListDomainsInputPaginateTypeDef = {  # (1)
    "registrationStatus": ...,
}

parent.paginate(**kwargs)

1. See ListDomainsInputPaginateTypeDef

ListOpenWorkflowExecutionsPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("list_open_workflow_executions"). boto3 documentation

# ListOpenWorkflowExecutionsPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import ListOpenWorkflowExecutionsPaginator

def get_list_open_workflow_executions_paginator() -> ListOpenWorkflowExecutionsPaginator:
    return Session().client("swf").get_paginator("list_open_workflow_executions")

# ListOpenWorkflowExecutionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import ListOpenWorkflowExecutionsPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: ListOpenWorkflowExecutionsPaginator = client.get_paginator("list_open_workflow_executions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: ListOpenWorkflowExecutionsPaginator
3. item: PageIterator[WorkflowExecutionInfosTypeDef]

paginate

Type annotations and code completion for ListOpenWorkflowExecutionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    startTimeFilter: ExecutionTimeFilterTypeDef,  # (1)
    typeFilter: WorkflowTypeFilterTypeDef = ...,  # (2)
    tagFilter: TagFilterTypeDef = ...,  # (3)
    reverseOrder: bool = ...,
    executionFilter: WorkflowExecutionFilterTypeDef = ...,  # (4)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (5)
) -> botocore.paginate.PageIterator[WorkflowExecutionInfosTypeDef]:  # (6)
    ...

1. See ExecutionTimeFilterTypeDef
2. See WorkflowTypeFilterTypeDef
3. See TagFilterTypeDef
4. See WorkflowExecutionFilterTypeDef
5. See PaginatorConfigTypeDef
6. See PageIterator[WorkflowExecutionInfosTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListOpenWorkflowExecutionsInputPaginateTypeDef = {  # (1)
    "domain": ...,
    "startTimeFilter": ...,
}

parent.paginate(**kwargs)

1. See ListOpenWorkflowExecutionsInputPaginateTypeDef

ListWorkflowTypesPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("list_workflow_types"). boto3 documentation

# ListWorkflowTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import ListWorkflowTypesPaginator

def get_list_workflow_types_paginator() -> ListWorkflowTypesPaginator:
    return Session().client("swf").get_paginator("list_workflow_types")

# ListWorkflowTypesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import ListWorkflowTypesPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: ListWorkflowTypesPaginator = client.get_paginator("list_workflow_types")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: ListWorkflowTypesPaginator
3. item: PageIterator[WorkflowTypeInfosTypeDef]

paginate

Type annotations and code completion for ListWorkflowTypesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    registrationStatus: RegistrationStatusType,  # (1)
    name: str = ...,
    reverseOrder: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[WorkflowTypeInfosTypeDef]:  # (3)
    ...

1. See RegistrationStatusType
2. See PaginatorConfigTypeDef
3. See PageIterator[WorkflowTypeInfosTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListWorkflowTypesInputPaginateTypeDef = {  # (1)
    "domain": ...,
    "registrationStatus": ...,
}

parent.paginate(**kwargs)

1. See ListWorkflowTypesInputPaginateTypeDef

PollForDecisionTaskPaginator

Type annotations and code completion for boto3.client("swf").get_paginator("poll_for_decision_task"). boto3 documentation

# PollForDecisionTaskPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import PollForDecisionTaskPaginator

def get_poll_for_decision_task_paginator() -> PollForDecisionTaskPaginator:
    return Session().client("swf").get_paginator("poll_for_decision_task")

# PollForDecisionTaskPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_swf.paginator import PollForDecisionTaskPaginator

session = Session()

client = Session().client("swf")  # (1)
paginator: PollForDecisionTaskPaginator = client.get_paginator("poll_for_decision_task")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SWFClient
2. paginator: PollForDecisionTaskPaginator
3. item: PageIterator[DecisionTaskTypeDef]

paginate

Type annotations and code completion for PollForDecisionTaskPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domain: str,
    taskList: TaskListTypeDef,  # (1)
    identity: str = ...,
    reverseOrder: bool = ...,
    startAtPreviousStartedEvent: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[DecisionTaskTypeDef]:  # (3)
    ...

1. See TaskListTypeDef
2. See PaginatorConfigTypeDef
3. See PageIterator[DecisionTaskTypeDef]

# paginate method usage example with argument unpacking

kwargs: PollForDecisionTaskInputPaginateTypeDef = {  # (1)
    "domain": ...,
    "taskList": ...,
}

parent.paginate(**kwargs)

1. See PollForDecisionTaskInputPaginateTypeDef