List Rules

eventbridge_list_rules

R Documentation

Lists your Amazon EventBridge rules¶

Description¶

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

The maximum number of results per page for requests is 100.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use list_targets_by_rule.

Usage¶

eventbridge_list_rules(NamePrefix, EventBusName, NextToken, Limit)

Arguments¶

NamePrefix: The prefix matching the rule name.
EventBusName: The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
NextToken: The token returned by a previous call to retrieve the next set of results.
Limit: The maximum number of results to return.

Value¶

A list with the following syntax:

list(
  Rules = list(
    list(
      Name = "string",
      Arn = "string",
      EventPattern = "string",
      State = "ENABLED"|"DISABLED"|"ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS",
      Description = "string",
      ScheduleExpression = "string",
      RoleArn = "string",
      ManagedBy = "string",
      EventBusName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_rules(
  NamePrefix = "string",
  EventBusName = "string",
  NextToken = "string",
  Limit = 123
)