Paginators

Index > EventBridge > Paginators

Auto-generated documentation for EventBridge type annotations stubs module types-boto3-events.

ListRuleNamesByTargetPaginator

Type annotations and code completion for boto3.client("events").get_paginator("list_rule_names_by_target"). boto3 documentation

# ListRuleNamesByTargetPaginator usage example

from boto3.session import Session

from types_boto3_events.paginator import ListRuleNamesByTargetPaginator

def get_list_rule_names_by_target_paginator() -> ListRuleNamesByTargetPaginator:
    return Session().client("events").get_paginator("list_rule_names_by_target")

# ListRuleNamesByTargetPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_events.paginator import ListRuleNamesByTargetPaginator

session = Session()

client = Session().client("events")  # (1)
paginator: ListRuleNamesByTargetPaginator = client.get_paginator("list_rule_names_by_target")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgeClient
2. paginator: ListRuleNamesByTargetPaginator
3. item: PageIterator[ListRuleNamesByTargetResponseTypeDef]

paginate

Type annotations and code completion for ListRuleNamesByTargetPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    TargetArn: str,
    EventBusName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListRuleNamesByTargetResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListRuleNamesByTargetResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListRuleNamesByTargetRequestPaginateTypeDef = {  # (1)
    "TargetArn": ...,
}

parent.paginate(**kwargs)

1. See ListRuleNamesByTargetRequestPaginateTypeDef

ListRulesPaginator

Type annotations and code completion for boto3.client("events").get_paginator("list_rules"). boto3 documentation

# ListRulesPaginator usage example

from boto3.session import Session

from types_boto3_events.paginator import ListRulesPaginator

def get_list_rules_paginator() -> ListRulesPaginator:
    return Session().client("events").get_paginator("list_rules")

# ListRulesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_events.paginator import ListRulesPaginator

session = Session()

client = Session().client("events")  # (1)
paginator: ListRulesPaginator = client.get_paginator("list_rules")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgeClient
2. paginator: ListRulesPaginator
3. item: PageIterator[ListRulesResponseTypeDef]

paginate

Type annotations and code completion for ListRulesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListRulesResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListRulesRequestPaginateTypeDef

ListTargetsByRulePaginator

Type annotations and code completion for boto3.client("events").get_paginator("list_targets_by_rule"). boto3 documentation

# ListTargetsByRulePaginator usage example

from boto3.session import Session

from types_boto3_events.paginator import ListTargetsByRulePaginator

def get_list_targets_by_rule_paginator() -> ListTargetsByRulePaginator:
    return Session().client("events").get_paginator("list_targets_by_rule")

# ListTargetsByRulePaginator usage example with type annotations

from boto3.session import Session

from types_boto3_events.paginator import ListTargetsByRulePaginator

session = Session()

client = Session().client("events")  # (1)
paginator: ListTargetsByRulePaginator = client.get_paginator("list_targets_by_rule")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgeClient
2. paginator: ListTargetsByRulePaginator
3. item: PageIterator[ListTargetsByRuleResponseTypeDef]

paginate

Type annotations and code completion for ListTargetsByRulePaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Rule: str,
    EventBusName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListTargetsByRuleResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListTargetsByRuleResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListTargetsByRuleRequestPaginateTypeDef = {  # (1)
    "Rule": ...,
}

parent.paginate(**kwargs)

1. See ListTargetsByRuleRequestPaginateTypeDef