Skip to content

DescribeRule

Source: src/AWS/EventBridge/DescribeRule.ts

Reads the configuration of an EventBridge rule (events:DescribeRule).

Bind this operation to a Rule inside a function runtime to get a callable that automatically injects the rule and bus names. Provide the DescribeRuleHttp layer on the Function to satisfy the binding.

// init — bind the rule (provide AWS.EventBridge.DescribeRuleHttp on the Function)
const describeRule = yield* AWS.EventBridge.DescribeRule(rule);
// runtime — read the rule's state and pattern
const info = yield* describeRule();
console.log(info.State, info.EventPattern);