Paginators

Index > EventBridgeScheduler > Paginators

Auto-generated documentation for EventBridgeScheduler type annotations stubs module mypy-boto3-scheduler.

ListScheduleGroupsPaginator

Type annotations and code completion for boto3.client("scheduler").get_paginator("list_schedule_groups"). boto3 documentation

# ListScheduleGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_scheduler.paginator import ListScheduleGroupsPaginator

def get_list_schedule_groups_paginator() -> ListScheduleGroupsPaginator:
    return Session().client("scheduler").get_paginator("list_schedule_groups")

# ListScheduleGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_scheduler.paginator import ListScheduleGroupsPaginator

session = Session()

client = Session().client("scheduler")  # (1)
paginator: ListScheduleGroupsPaginator = client.get_paginator("list_schedule_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgeSchedulerClient
2. paginator: ListScheduleGroupsPaginator
3. item: ListScheduleGroupsOutputTypeDef

paginate

Type annotations and code completion for ListScheduleGroupsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListScheduleGroupsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListScheduleGroupsInputPaginateTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.paginate(**kwargs)

1. See ListScheduleGroupsInputPaginateTypeDef

ListSchedulesPaginator

Type annotations and code completion for boto3.client("scheduler").get_paginator("list_schedules"). boto3 documentation

# ListSchedulesPaginator usage example

from boto3.session import Session

from mypy_boto3_scheduler.paginator import ListSchedulesPaginator

def get_list_schedules_paginator() -> ListSchedulesPaginator:
    return Session().client("scheduler").get_paginator("list_schedules")

# ListSchedulesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_scheduler.paginator import ListSchedulesPaginator

session = Session()

client = Session().client("scheduler")  # (1)
paginator: ListSchedulesPaginator = client.get_paginator("list_schedules")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgeSchedulerClient
2. paginator: ListSchedulesPaginator
3. item: ListSchedulesOutputTypeDef

paginate

Type annotations and code completion for ListSchedulesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    GroupName: str = ...,
    NamePrefix: str = ...,
    State: ScheduleStateType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListSchedulesOutputTypeDef]:  # (3)
    ...

1. See ScheduleStateType
2. See PaginatorConfigTypeDef
3. See ListSchedulesOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListSchedulesInputPaginateTypeDef = {  # (1)
    "GroupName": ...,
}

parent.paginate(**kwargs)

1. See ListSchedulesInputPaginateTypeDef