aws-sdk-connect 1.241.0 → 1.243.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6bb3c3806af4dec9bf434ee8d918b742a98a8cfbb0dfcd902bdca21af60035a
-  data.tar.gz: f283abcc541297a8b9ffd36d333e673a92ca20d0b2767f9cde0fa4bbbed0e487
+  metadata.gz: c63d9e1e680e1b6a0bb4cdfd1a3792b8da8c6cd9b51fa08f1bd2ca8f86b7b5aa
+  data.tar.gz: 52b359313f585d702598091e0f5806075d5fcc1fc057a386b35e4904b365be37
 SHA512:
-  metadata.gz: 729924505cc82a35c0d4cf4f08a2c2ebe66db505e6f3a6f38502191852146ca2ee00eae0af70c9802a306ae1339e9fe10b443b7d550a50321caf088a9053ce06
-  data.tar.gz: 96009b32ccaa384f3aac55ae5c0c19933228a8ea46ed693ab2047f82cd4a4718b894a85e9a55599a8bf5fe0be138759baeacecf513250cbd1598e75d3792aeb3
+  metadata.gz: 799ed5895ba4bf27ba9119ede54eb78130297f4684a1a0d1ff1d84b66f0b770aed01c7256fe67ee18dde6a112709c672771b61cc44035147e280e570fd510689
+  data.tar.gz: 6b10f3c775515bac3964199e94a542bd44b9aea96c85808282db38b8be1fcbb670300dae6401718c8e534264e94f91c37fd29711787195c86a69ed910f79d522

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.243.0 (2026-02-18)
+------------------
+
+* Feature - Correcting in-app notifications API documentation.
+
+1.242.0 (2026-02-13)
+------------------
+
+* Feature - API release for headerr notifications in the admin website. APIs allow customers to publish brief messages (including URLs) to a specified audience, and a new header icon will indicate when unread messages are available.
+
 1.241.0 (2026-02-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.241.0
+1.243.0

data/lib/aws-sdk-connect/client.rb

@@ -3784,6 +3784,95 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :expires_at
+    #   The timestamp when the notification should expire and no longer be
+    #   displayed to users. If not specified, defaults to one week from
+    #   creation.
+    #
+    # @option params [required, Array<String>] :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.
+    #
+    # @option params [String] :priority
+    #   The priority level of the notification. Valid values are HIGH and LOW.
+    #   High priority notifications are displayed above low priority
+    #   notifications.
+    #
+    # @option params [required, Hash<String,String>] :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 links. Maximum 250 characters per locale.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   The tags used to organize, track, or control access for this resource.
+    #   For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.
+    #
+    # @option params [String] :predefined_notification_id
+    #   The unique identifier for a notification.
+    #
+    # @option params [String] :client_token
+    #   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][1].
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
+    #
+    # @return [Types::CreateNotificationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateNotificationResponse#notification_id #notification_id} => String
+    #   * {Types::CreateNotificationResponse#notification_arn #notification_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_notification({
+    #     instance_id: "InstanceId", # required
+    #     expires_at: Time.now,
+    #     recipients: ["ARN"], # required
+    #     priority: "HIGH", # accepts HIGH, LOW
+    #     content: { # required
+    #       "en_US" => "LocalizedString",
+    #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #     predefined_notification_id: "NotificationId",
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.notification_id #=> String
+    #   resp.notification_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateNotification AWS API Documentation
+    #
+    # @overload create_notification(params = {})
+    # @param [Hash] params ({})
+    def create_notification(params = {}, options = {})
+      req = build_request(:create_notification, params)
+      req.send_request(options)
+    end
+
     # Adds a new participant into an on-going chat contact or webRTC call.
     # For more information, see [Customize chat flow experiences by
     # integrating custom participants][1] or [Enable multi-user web, in-app,
@@ -6428,6 +6517,39 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Deletes a notification. Once deleted, the notification is no longer
+    # visible to all users and cannot be managed through the Admin Website
+    # or APIs.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [required, String] :notification_id
+    #   The unique identifier for the notification to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_notification({
+    #     instance_id: "InstanceId", # required
+    #     notification_id: "NotificationId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteNotification AWS API Documentation
+    #
+    # @overload delete_notification(params = {})
+    # @param [Hash] params ({})
+    def delete_notification(params = {}, options = {})
+      req = build_request(:delete_notification, params)
+      req.send_request(options)
+    end
+
     # Deletes a predefined attribute from the specified Amazon Connect
     # instance.
     #
@@ -8393,6 +8515,56 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Retrieves detailed information about a specific notification,
+    # including its content, priority, recipients, and metadata.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [required, String] :notification_id
+    #   The unique identifier for the notification.
+    #
+    # @return [Types::DescribeNotificationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeNotificationResponse#notification #notification} => Types::Notification
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_notification({
+    #     instance_id: "InstanceId", # required
+    #     notification_id: "NotificationId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.notification.content #=> Hash
+    #   resp.notification.content["LocaleCode"] #=> String
+    #   resp.notification.id #=> String
+    #   resp.notification.arn #=> String
+    #   resp.notification.priority #=> String, one of "URGENT", "HIGH", "LOW"
+    #   resp.notification.recipients #=> Array
+    #   resp.notification.recipients[0] #=> String
+    #   resp.notification.last_modified_time #=> Time
+    #   resp.notification.created_at #=> Time
+    #   resp.notification.expires_at #=> Time
+    #   resp.notification.last_modified_region #=> String
+    #   resp.notification.tags #=> Hash
+    #   resp.notification.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeNotification AWS API Documentation
+    #
+    # @overload describe_notification(params = {})
+    # @param [Hash] params ({})
+    def describe_notification(params = {}, options = {})
+      req = build_request(:describe_notification, params)
+      req.send_request(options)
+    end
+
     # Gets details and status of a phone number that’s claimed to your
     # Amazon Connect instance or traffic distribution group.
     #
@@ -16052,6 +16224,65 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Retrieves a paginated list of all notifications in the Amazon Connect
+    # instance.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response to retrieve the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page. Valid range is
+    #   1-100.
+    #
+    # @return [Types::ListNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListNotificationsResponse#next_token #next_token} => String
+    #   * {Types::ListNotificationsResponse#notification_summary_list #notification_summary_list} => Array&lt;Types::Notification&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_notifications({
+    #     instance_id: "InstanceId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.notification_summary_list #=> Array
+    #   resp.notification_summary_list[0].content #=> Hash
+    #   resp.notification_summary_list[0].content["LocaleCode"] #=> String
+    #   resp.notification_summary_list[0].id #=> String
+    #   resp.notification_summary_list[0].arn #=> String
+    #   resp.notification_summary_list[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
+    #   resp.notification_summary_list[0].recipients #=> Array
+    #   resp.notification_summary_list[0].recipients[0] #=> String
+    #   resp.notification_summary_list[0].last_modified_time #=> Time
+    #   resp.notification_summary_list[0].created_at #=> Time
+    #   resp.notification_summary_list[0].expires_at #=> Time
+    #   resp.notification_summary_list[0].last_modified_region #=> String
+    #   resp.notification_summary_list[0].tags #=> Hash
+    #   resp.notification_summary_list[0].tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListNotifications AWS API Documentation
+    #
+    # @overload list_notifications(params = {})
+    # @param [Hash] params ({})
+    def list_notifications(params = {}, options = {})
+      req = build_request(:list_notifications, params)
+      req.send_request(options)
+    end
+
     # Provides information about the phone numbers for the specified Amazon
     # Connect instance.
     #
@@ -17756,6 +17987,66 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Retrieves a paginated list of notifications for a specific user,
+    # including the notification status for that user.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response to retrieve the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page. Valid range is
+    #   1-1000.
+    #
+    # @option params [required, String] :user_id
+    #   The identifier of the user.
+    #
+    # @return [Types::ListUserNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListUserNotificationsResponse#user_notifications #user_notifications} => Array&lt;Types::UserNotificationSummary&gt;
+    #   * {Types::ListUserNotificationsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_user_notifications({
+    #     instance_id: "InstanceId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     user_id: "UserId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.user_notifications #=> Array
+    #   resp.user_notifications[0].notification_id #=> String
+    #   resp.user_notifications[0].notification_status #=> String, one of "READ", "UNREAD", "HIDDEN"
+    #   resp.user_notifications[0].instance_id #=> String
+    #   resp.user_notifications[0].recipient_id #=> String
+    #   resp.user_notifications[0].content #=> Hash
+    #   resp.user_notifications[0].content["LocaleCode"] #=> String
+    #   resp.user_notifications[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
+    #   resp.user_notifications[0].source #=> String, one of "CUSTOMER", "RULES", "SYSTEM"
+    #   resp.user_notifications[0].created_at #=> Time
+    #   resp.user_notifications[0].expires_at #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserNotifications AWS API Documentation
+    #
+    # @overload list_user_notifications(params = {})
+    # @param [Hash] params ({})
+    def list_user_notifications(params = {}, options = {})
+      req = build_request(:list_user_notifications, params)
+      req.send_request(options)
+    end
+
     # Lists proficiencies associated with a user.
     #
     # @option params [required, String] :instance_id
@@ -19907,6 +20198,121 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Searches for notifications based on specified criteria and filters.
+    # Returns a paginated list of notifications matching the search
+    # parameters, ordered by descending creation time. Supports filtering by
+    # content and tags.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response to retrieve the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page. Valid range is
+    #   1-100.
+    #
+    # @option params [Types::NotificationSearchFilter] :search_filter
+    #   Filters to apply to the search results, such as tag-based filters.
+    #
+    # @option params [Types::NotificationSearchCriteria] :search_criteria
+    #   The search criteria to apply when searching for notifications.
+    #   Supports filtering by notification ID and message content using
+    #   comparison types such as STARTS\_WITH, CONTAINS, and EXACT.
+    #
+    # @return [Types::SearchNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SearchNotificationsResponse#notifications #notifications} => Array&lt;Types::NotificationSearchSummary&gt;
+    #   * {Types::SearchNotificationsResponse#next_token #next_token} => String
+    #   * {Types::SearchNotificationsResponse#approximate_total_count #approximate_total_count} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.search_notifications({
+    #     instance_id: "InstanceId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     search_filter: {
+    #       attribute_filter: {
+    #         or_conditions: [
+    #           {
+    #             tag_conditions: [
+    #               {
+    #                 tag_key: "String",
+    #                 tag_value: "String",
+    #               },
+    #             ],
+    #           },
+    #         ],
+    #         and_condition: {
+    #           tag_conditions: [
+    #             {
+    #               tag_key: "String",
+    #               tag_value: "String",
+    #             },
+    #           ],
+    #         },
+    #         tag_condition: {
+    #           tag_key: "String",
+    #           tag_value: "String",
+    #         },
+    #       },
+    #     },
+    #     search_criteria: {
+    #       or_conditions: [
+    #         {
+    #           # recursive NotificationSearchCriteria
+    #         },
+    #       ],
+    #       and_conditions: [
+    #         {
+    #           # recursive NotificationSearchCriteria
+    #         },
+    #       ],
+    #       string_condition: {
+    #         field_name: "String",
+    #         value: "String",
+    #         comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
+    #       },
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.notifications #=> Array
+    #   resp.notifications[0].id #=> String
+    #   resp.notifications[0].arn #=> String
+    #   resp.notifications[0].instance_id #=> String
+    #   resp.notifications[0].content #=> Hash
+    #   resp.notifications[0].content["LocaleCode"] #=> String
+    #   resp.notifications[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
+    #   resp.notifications[0].recipients #=> Array
+    #   resp.notifications[0].recipients[0] #=> String
+    #   resp.notifications[0].created_at #=> Time
+    #   resp.notifications[0].expires_at #=> Time
+    #   resp.notifications[0].last_modified_region #=> String
+    #   resp.notifications[0].last_modified_time #=> Time
+    #   resp.notifications[0].tags #=> Hash
+    #   resp.notifications[0].tags["TagKey"] #=> String
+    #   resp.next_token #=> String
+    #   resp.approximate_total_count #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchNotifications AWS API Documentation
+    #
+    # @overload search_notifications(params = {})
+    # @param [Hash] params ({})
+    def search_notifications(params = {}, options = {})
+      req = build_request(:search_notifications, params)
+      req.send_request(options)
+    end
+
     # Searches predefined attributes that meet certain criteria. A
     # *predefined attribute* is made up of a name and a value. You can use
     # predefined attributes for:
@@ -25790,6 +26196,45 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Updates the localized content of an existing notification. This
+    # operation applies to all users for whom the notification was sent.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [required, String] :notification_id
+    #   The unique identifier for the notification to update.
+    #
+    # @option params [required, Hash<String,String>] :content
+    #   The updated localized content of the notification. A map of locale
+    #   codes and values. Maximum 500 characters per locale.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_notification_content({
+    #     instance_id: "InstanceId", # required
+    #     notification_id: "NotificationId", # required
+    #     content: { # required
+    #       "en_US" => "LocalizedString",
+    #     },
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateNotificationContent AWS API Documentation
+    #
+    # @overload update_notification_content(params = {})
+    # @param [Hash] params ({})
+    def update_notification_content(params = {}, options = {})
+      req = build_request(:update_notification_content, params)
+      req.send_request(options)
+    end
+
     # Instructs Amazon Connect to resume the authentication process. The
     # subsequent actions depend on the request body contents:
     #
@@ -27568,6 +28013,60 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Updates the status of a notification for a specific user, such as
+    # marking it as read or hidden. Users can only update notification
+    # status for notifications that have been sent to them. READ status
+    # deprioritizes the notification and greys it out, while HIDDEN status
+    # removes it from the notification widget.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [required, String] :notification_id
+    #   The unique identifier for the notification.
+    #
+    # @option params [required, String] :user_id
+    #   The identifier of the user whose notification status is being updated.
+    #
+    # @option params [required, String] :status
+    #   The new status for the notification. Valid values are READ, UNREAD,
+    #   and HIDDEN.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :last_modified_time
+    #   The timestamp when the notification status was last modified. Used for
+    #   cross-region replication and optimistic locking.
+    #
+    # @option params [String] :last_modified_region
+    #   The AWS Region where the notification status was last modified. Used
+    #   for cross-region replication.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_user_notification_status({
+    #     instance_id: "InstanceId", # required
+    #     notification_id: "NotificationId", # required
+    #     user_id: "UserId", # required
+    #     status: "READ", # required, accepts READ, UNREAD, HIDDEN
+    #     last_modified_time: Time.now,
+    #     last_modified_region: "RegionName",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserNotificationStatus AWS API Documentation
+    #
+    # @overload update_user_notification_status(params = {})
+    # @param [Hash] params ({})
+    def update_user_notification_status(params = {}, options = {})
+      req = build_request(:update_user_notification_status, params)
+      req.send_request(options)
+    end
+
     # Updates the phone configuration settings for the specified user.
     #
     # <note markdown="1"> We recommend using the [UpdateUserConfig][1] API, which supports
@@ -28106,7 +28605,7 @@ module Aws::Connect
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.241.0'
+      context[:gem_version] = '1.243.0'
       Seahorse::Client::Request.new(handlers, context)
     end