Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEventRule

Returns a specified EventRule.

Request Syntax


GET /event-rules/arn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

arn

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

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "eventPattern": "string",
   "eventType": "string",
   "managedRules": [ "string" ],
   "notificationConfigurationArn": "string",
   "regions": [ "string" ],
   "source": "string",
   "statusSummaryByRegion": { 
      "string" : { 
         "reason": "string",
         "status": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN of the resource.

Type: String

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}

creationTime

The date when the EventRule was created.

Type: Timestamp

eventPattern

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

eventType

The event type to match.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ([a-zA-Z0-9 \-\(\)])+

managedRules

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

Note

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

Type: Array of strings

Pattern: arn:aws:events:[a-z-\d]{2,25}:\d{12}:rule\/[a-zA-Z-\d]{1,1024}

notificationConfigurationArn

The ARN of a NotificationConfiguration.

Type: String

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}

regions

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 2. Maximum length of 25.

Pattern: ([a-z]{1,2})-([a-z]{1,15}-)+([0-9])

source

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: aws.([a-z0-9\-])+

statusSummaryByRegion

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

Type: String to EventRuleStatusSummary object map

Key Length Constraints: Minimum length of 2. Maximum length of 25.

Key Pattern: ([a-z]{1,2})-([a-z]{1,15}-)+([0-9])

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The ID of the resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service being throttled.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

fieldList: The list of input fields that are invalid.
reason: The reason why your input is considered invalid.

HTTP Status Code: 400