Skip to content

CreateNotificationRequest

Source code in docs_src/capo_connect/types/create_notification_request.py
class CreateNotificationRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    expires_at: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.</p>"""
    recipients: "capo_connect.types.recipient_list.RecipientList"
    """<p>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.</p>"""
    priority: NotRequired[
        "capo_connect.types.configurable_notification_priority.ConfigurableNotificationPriority"
    ]
    """<p>The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.</p>"""
    content: "capo_connect.types.notification_content.NotificationContent"
    """<p>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.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>"""
    predefined_notification_id: NotRequired[
        "capo_connect.types.notification_id.NotificationId"
    ]
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""

client_token instance-attribute

client_token: NotRequired[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.

content instance-attribute

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.

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

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

instance_id instance-attribute

instance_id: InstanceId

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

predefined_notification_id instance-attribute

predefined_notification_id: NotRequired[NotificationId]

priority instance-attribute

priority: NotRequired[ConfigurableNotificationPriority]

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

recipients instance-attribute

recipients: RecipientList

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.

tags instance-attribute

tags: NotRequired[TagMap]

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