Skip to content

ListRulesRequest

Source code in docs_src/capo_eventbridge/types/list_rules_request.py 
14
15
16
17
18
19
20
21
22
23
24
class ListRulesRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_eventbridge.types.rule_name.RuleName"]
    """<p>The prefix matching the rule name.</p>"""
    event_bus_name: NotRequired[
        "capo_eventbridge.types.event_bus_name_or_arn.EventBusNameOrArn"
    ]
    """<p>The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.</p>"""
    next_token: NotRequired["capo_eventbridge.types.next_token.NextToken"]
    """<p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p> Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>"""
    limit: NotRequired["capo_eventbridge.types.limit_max100.LimitMax100"]
    """<p>The maximum number of results to return.</p>"""

event_bus_name instance-attribute 

event_bus_name: NotRequired[EventBusNameOrArn]

The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

limit instance-attribute 

limit: NotRequired[LimitMax100]

The maximum number of results to return.

name_prefix instance-attribute 

name_prefix: NotRequired[RuleName]

The prefix matching the rule name.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.