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

CreateNotificationConfiguration

Creates a new NotificationConfiguration.

Request Syntax


POST /notification-configurations HTTP/1.1
Content-type: application/json

{
   "aggregationDuration": "string",
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

aggregationDuration

The aggregation preference of the NotificationConfiguration.

Values:
- LONG
  - Aggregate notifications for long periods of time (12 hours).
- SHORT
  - Aggregate notifications for short periods of time (5 minutes).
- NONE
  - Don't aggregate notifications.
    
    No delay in delivery.

Type: String

Valid Values: LONG | SHORT | NONE

Required: No

description

The description of the NotificationConfiguration.

Type: String

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

Pattern: [^\u0001-\u001F\u007F-\u009F]*

Required: Yes

name

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

Type: String

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

Pattern: [A-Za-z0-9_\-]+

Required: Yes

tags

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Pattern: (?!aws:).{1,128}

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "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 Amazon Resource Name (ARN) of the the resource.

Type: String

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

status

The status of this NotificationConfiguration.

The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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.
- 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.

Type: String

Valid Values: ACTIVE | PARTIALLY_ACTIVE | INACTIVE | DELETING

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

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

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