Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . events ]

describe-rule

Description

Describes the specified rule.

DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-rule
--name <value>
[--event-bus-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the rule.

--event-bus-name (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To display information about a CloudWatch Events rule

This example displays information about the rule named DailyLambdaFunction:

aws events describe-rule --name "DailyLambdaFunction"

Output

Name -> (string)

The name of the rule.

Arn -> (string)

The Amazon Resource Name (ARN) of the rule.

EventPattern -> (string)

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

ScheduleExpression -> (string)

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

State -> (string)

Specifies whether the rule is enabled or disabled.

Description -> (string)

The description of the rule.

RoleArn -> (string)

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

ManagedBy -> (string)

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

EventBusName -> (string)

The event bus associated with the rule.