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

CreateEventRule

Creates an EventRule that is associated with a specified NotificationConfiguration.

Request Syntax


POST /event-rules HTTP/1.1
Content-type: application/json

{
   "eventPattern": "string",
   "eventType": "string",
   "notificationConfigurationArn": "string",
   "regions": [ "string" ],
   "source": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Required: No

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 \-\(\)])+

Required: Yes

notificationConfigurationArn

The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.

Type: String

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

Required: Yes

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])

Required: Yes

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\-])+

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "notificationConfigurationArn": "string",
   "statusSummaryByRegion": { 
      "string" : { 
         "reason": "string",
         "status": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 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}

notificationConfigurationArn

The ARN of a NotificationConfiguration.

Type: String

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

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

resourceId: The resource ID that prompted the conflict error.

HTTP Status Code: 409

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

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

quotaCode: The code for the service quota in Service Quotas.
resourceId: The ID of the resource that exceeds the service quota.
resourceType: The type of the resource that exceeds the service quota.
serviceCode: The code for the service quota exceeded in Service Quotas.

HTTP Status Code: 402

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