Skip to content

Create Notification

connect_create_notification R Documentation

Creates a new notification to be delivered to specified recipients

Description

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

Usage

connect_create_notification(InstanceId, ExpiresAt, Recipients, Priority,
  Content, Tags, PredefinedNotificationId, ClientToken)

Arguments

InstanceId

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

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

[required] 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.
Priority

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

[required] The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.
Tags

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

The unique identifier for a notification.
ClientToken

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

Value

A list with the following syntax:

list(
  NotificationId = "string",
  NotificationArn = "string"
)

Request syntax

svc$create_notification(
  InstanceId = "string",
  ExpiresAt = as.POSIXct(
    "2015-01-01"
  ),
  Recipients = list(
    "string"
  ),
  Priority = "HIGH"|"LOW",
  Content = list(
    "string"
  ),
  Tags = list(
    "string"
  ),
  PredefinedNotificationId = "string",
  ClientToken = "string"
)