# list-event-rules ## Description Returns a list of `EventRules` according to specified filters, in reverse chronological order (newest first). See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRules) `list-event-rules` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `eventRules` ## Synopsis ``` list-event-rules --notification-configuration-arn [--starting-token ] [--page-size ] [--max-items ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--notification-configuration-arn` (string) [required] > The Amazon Resource Name (ARN) of the `NotificationConfiguration` . > Constraints: > * pattern: `arn:[a-z-]{3,10}:notifications::[0-9]{12}:configuration/[a-z0-9]{27}` `--starting-token` (string) > A token to specify where to start paginating. This is the `NextToken` from a previously truncated response. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--page-size` (integer) > The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . > Constraints: > * min: `1` > * max: `1000` `--max-items` (integer) > The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`. `--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## 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 * yaml * yaml-stream * off `--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. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Output nextToken -> (string) > A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. > Constraints: > * min: `1` > * max: `4096` > * pattern: `[\w+-/=]+` eventRules -> (list) > A list of `EventRules` . > (structure) > > Contains a complete list of fields related to an `EventRule` . > > arn -> (string) [required] > > > The Amazon Resource Name (ARN) of the `EventRule` . CloudFormation stack generates this ARN and then uses this ARN to associate with the `NotificationConfiguration` . > > > Constraints: > > > * pattern: `arn:[a-z-]{3,10}:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}` > > notificationConfigurationArn -> (string) [required] > > > The ARN for the `NotificationConfiguration` associated with this `EventRule` . > > > Constraints: > > > * pattern: `arn:[a-z-]{3,10}:notifications::[0-9]{12}:configuration/[a-z0-9]{27}` > > creationTime -> (timestamp) [required] > > > The creation time of the `EventRule` . > > source -> (string) [required] > > > The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, `aws.ec2` and `aws.cloudwatch` . For more information, see [Event delivery from Amazon Web Services services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level) in the *Amazon EventBridge User Guide* . > > > Constraints: > > > * min: `1` > > > * max: `36` > > > * pattern: `aws.([a-z0-9\-])+` > > eventType -> (string) [required] > > > The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see [Event delivery from Amazon Web Services services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level) in the *Amazon EventBridge User Guide* . > > > Constraints: > > > * min: `1` > > > * max: `128` > > > * pattern: `([a-zA-Z0-9 \-\(\)])+` > > eventPattern -> (string) [required] > > > An additional event pattern used to further filter the events this `EventRule` receives. > > > For more information, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) in the *Amazon EventBridge User Guide.* > > > Constraints: > > > * min: `0` > > > * max: `4096` > > regions -> (list) [required] > > > A list of Amazon Web Services Regions that send events to this `EventRule` . > > > Constraints: > > > * min: `1` > > > (string) > > > > Constraints: > > > > * min: `2` > > > > * max: `25` > > > > * pattern: `([a-z]{1,4})-([a-z]{1,15}-)+([0-9])` > > managedRules -> (list) [required] > > > A list of Amazon EventBridge Managed Rule ARNs associated with this `EventRule` . > > > #### NOTE > > > These are created by User Notifications within your account so your `EventRules` can function. > > > (string) > > > > Constraints: > > > > * pattern: `arn:[a-z-]{3,10}:events:[a-z-\d]{2,25}:\d{12}:rule\/[a-zA-Z-\d]{1,1024}` > > statusSummaryByRegion -> (map) [required] > > > A list of an `EventRule` ‘s status by Region. Regions are mapped to `EventRuleStatusSummary` . > > > key -> (string) > > > > Constraints: > > > > * min: `2` > > > > * max: `25` > > > > * pattern: `([a-z]{1,4})-([a-z]{1,15}-)+([0-9])` > > > value -> (structure) > > > > Provides additional information about the current `EventRule` status. > > > > status -> (string) [required] > > > > > 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. > > > > > Possible values: > > > > > * `ACTIVE` > > > > > * `INACTIVE` > > > > > * `CREATING` > > > > > * `UPDATING` > > > > > * `DELETING` > > > > reason -> (string) [required] > > > > > A human-readable reason for `EventRuleStatus` .