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

CreateNotificationConfiguration

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

Request Syntax


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

{
   "ClientToken": "string",
   "DestinationName": "string",
   "EventType": "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.

ClientToken

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Type: String

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

Pattern: [a-zA-Z0-9=_-]+

Required: No

DestinationName

The name of the destination for the notification configuration.

Type: String

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

Pattern: [\p{L}\p{N} ._-]+

Required: Yes

EventType

The type of event triggering a device notification to the customer-managed destination.

Type: String

Required: Yes

Tags

This parameter has been deprecated.

A set of key/value pairs that are used to manage the notification configuration.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "EventType": "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.

EventType

The type of event triggering a device notification to the customer-managed destination.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

ConflictException

There is a conflict with the request.

HTTP Status Code: 409

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400