AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . notifications ]

get-event-rule

Description

Returns a specified EventRule.

See also: AWS API Documentation

Synopsis

  get-event-rule
--arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--arn (string)

The Amazon Resource Name (ARN) of the EventRule to return.

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

arn -> (string)

The ARN of the resource.

notificationConfigurationArn -> (string)

The ARN of a NotificationConfiguration.

creationTime -> (timestamp)

The date when the EventRule was created.

source -> (string)

The matched event source.

Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch . For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

eventType -> (string)

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

eventPattern -> (string)

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

regions -> (list)

A list of AWS Regions that send events to this EventRule.

(string)

managedRules -> (list)

A list of managed rules from EventBridge that are are associated with this EventRule.

Note

These are created by AWS User Notifications within your account so this EventRule functions.

(string)

statusSummaryByRegion -> (map)

A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.

key -> (string)

value -> (structure)

Describes EventRule status information.

status -> (string)

The status of the EventRule.

  • Values:
    • ACTIVE
      • The EventRule can process events.
    • INACTIVE
      • The EventRule may be unable to process events.
    • CREATING
      • The EventRule is being created. Only GET and LIST calls can be run.
    • UPDATING
      • The EventRule is being updated. Only GET and LIST calls can be run.
    • DELETING
      • The EventRule is being deleted. Only GET and LIST calls can be run.

reason -> (string)

A human-readable reason for EventRuleStatus.