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

ListNotificationConfigurations

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

Request Syntax


GET /notification-configurations?channelArn=channelArn&eventRuleSource=eventRuleSource&maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelArn

The Amazon Resource Name (ARN) of the Channel to match.

Pattern: arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+

eventRuleSource

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.

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

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

maxResults

The maximum number of results to be returned in this call. Defaults to 20.

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

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+-/=]+

status

The NotificationConfiguration status to match.

Values:
- ACTIVE
  - All EventRules are ACTIVE and any call can be run.
- PARTIALLY_ACTIVE
  - Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
  - Any call can be run.
- INACTIVE
  - All EventRules are INACTIVE and any call can be run.
- DELETING
  - This NotificationConfiguration is being deleted.
  - Only GET and LIST calls can be run.

Valid Values: ACTIVE | PARTIALLY_ACTIVE | INACTIVE | DELETING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "notificationConfigurations": [ 
      { 
         "aggregationDuration": "string",
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "name": "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.

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+-/=]+

notificationConfigurations

The NotificationConfigurations in the account.

Type: Array of NotificationConfigurationStructure objects

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

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