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

UpdateEventRule

Updates an existing EventRule.

Request Syntax


PUT /event-rules/arn HTTP/1.1
Content-type: application/json

{
   "eventPattern": "string",
   "regions": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

arn

The Amazon Resource Name (ARN) to use to update the EventRule.

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

Required: Yes

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

regions

A list of AWS Regions that sends 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: No

Response Syntax


HTTP/1.1 200
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 200 response.

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

arn

The Amazon Resource Name (ARN) to use to update the EventRule.

Type: String

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

notificationConfigurationArn

The ARN of the NotificationConfiguration.

Type: String

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

statusSummaryByRegion

The status of the action by Region.

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.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

HTTP Status Code: 400