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

ListEventRules

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

Request Syntax


GET /event-rules?maxResults=maxResults&nextToken=nextToken&notificationConfigurationArn=notificationConfigurationArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to be returned in this call. The default value is 20.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

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

Pattern: [\w+-/=]+

notificationConfigurationArn

The Amazon Resource Name (ARN) of the NotificationConfiguration.

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[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

{
   "eventRules": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "eventPattern": "string",
         "eventType": "string",
         "managedRules": [ "string" ],
         "notificationConfigurationArn": "string",
         "regions": [ "string" ],
         "source": "string",
         "statusSummaryByRegion": { 
            "string" : { 
               "reason": "string",
               "status": "string"
            }
         }
      }
   ],
   "nextToken": "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.

eventRules

A list of EventRules.

Type: Array of EventRuleStructure objects

nextToken

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Type: String

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

Pattern: [\w+-/=]+

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.

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