• Public
  • Public/Protected
  • All

Interface DescribeRuleCommandOutput





$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional Arn

Arn: undefined | string

The Amazon Resource Name (ARN) of the rule.

Optional CreatedBy

CreatedBy: undefined | string

The account ID of the user that created the rule. If you use PutRule 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 CreatedBy is the account ID as the account that created the rule in the other account.

Optional Description

Description: undefined | string

The description of the rule.

Optional EventBusName

EventBusName: undefined | string

The name of the event bus associated with the rule.

Optional EventPattern

EventPattern: undefined | string

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Optional ManagedBy

ManagedBy: undefined | string

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.

Optional Name

Name: undefined | string

The name of the rule.

Optional RoleArn

RoleArn: undefined | string

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

Optional ScheduleExpression

ScheduleExpression: undefined | string

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

Optional State

State: RuleState | string

Specifies whether the rule is enabled or disabled.