Describe Rule

eventbridge_describe_rule

R Documentation

Describes the specified rule¶

Description¶

Describes the specified rule.

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

Usage¶

eventbridge_describe_rule(Name, EventBusName)

Arguments¶

Name

[required] The name of the rule.

EventBusName

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$describe_rule(
  Name = "string",
  EventBusName = "string"
)