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

CreateNotification

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with embedded links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

Request Syntax


PUT /notifications/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Content": { 
      "string" : "string" 
   },
   "ExpiresAt": number,
   "PredefinedNotificationId": "string",
   "Priority": "string",
   "Recipients": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Content

The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports markdown formatting and embedded links. Maximum 250 characters per locale.

Type: String to string map

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

Required: Yes

ExpiresAt

The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.

Type: Timestamp

Required: No

PredefinedNotificationId

The unique identifier for a notification.

Type: String

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

Required: No

Priority

The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.

Type: String

Valid Values: HIGH | LOW

Required: No

Recipients

A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.

Type: Array of strings

Array Members: Maximum number of 200 items.

Required: Yes

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NotificationArn": "string",
   "NotificationId": "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.

NotificationArn

The Amazon Resource Name (ARN) of the created notification.

Type: String

NotificationId

The unique identifier assigned to the created notification.

Type: String

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

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429