Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Describes the specified rule.

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

post/#X-Amz-Target=AWSEvents.DescribeRule

Headers

X-Amz-Target'AWSEvents.DescribeRule' required

Request body

Namestring required

The name of the rule.

EventBusNamestring

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

Response

Success

Namestring

The name of the rule.

Arnstring

The Amazon Resource Name (ARN) of the rule.

EventPatternstring

The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.

ScheduleExpressionstring

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

State'ENABLED' | 'DISABLED'

Specifies whether the rule is enabled or disabled.

Descriptionstring

The description of the rule.

RoleArnstring

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

ManagedBystring

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

EventBusNamestring

The name of the event bus associated with the rule.

CreatedBystring

The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.