Amazon Connect Connect Notifications API

openapi: 3.1.0
info:
  title: Amazon Connect Service Notifications API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 7 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /notifications/{InstanceId}:
    put:
      operationId: CreateNotification
      summary: Create Notification
      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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotificationRequest'
      tags:
      - Notifications
    get:
      operationId: ListNotifications
      summary: List Notifications
      description: Retrieves a paginated list of all notifications in the Amazon Connect instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotificationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNotificationsRequest'
      tags:
      - Notifications
  /notifications/{InstanceId}/{NotificationId}:
    delete:
      operationId: DeleteNotification
      summary: Delete Notification
      description: Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be
        managed through the Admin Website or APIs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteNotificationRequest'
      tags:
      - Notifications
    get:
      operationId: DescribeNotification
      summary: Describe Notification
      description: Retrieves detailed information about a specific notification, including its content, priority, recipients,
        and metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeNotificationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeNotificationRequest'
      tags:
      - Notifications
    post:
      operationId: UpdateNotificationContent
      summary: Update Notification Content
      description: Updates the localized content of an existing notification. This operation applies to all users for whom
        the notification was sent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateNotificationContentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotificationContentRequest'
      tags:
      - Notifications
  /users/{InstanceId}/{UserId}/notifications:
    get:
      operationId: ListUserNotifications
      summary: List User Notifications
      description: Retrieves a paginated list of notifications for a specific user, including the notification status for
        that user.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUserNotificationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListUserNotificationsRequest'
      tags:
      - Notifications
  /users/{InstanceId}/{UserId}/notifications/{NotificationId}:
    post:
      operationId: UpdateUserNotificationStatus
      summary: Update User Notification Status
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUserNotificationStatusResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserNotificationStatusRequest'
      tags:
      - Notifications
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: connect
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CreateNotificationRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ExpiresAt:
          type: string
          format: date-time
          description: The timestamp when the notification should expire and no longer be displayed to users. If not specified,
            defaults to one week from creation.
        Recipients:
          type: array
          items:
            type: string
          description: 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:
          type: string
          enum:
          - HIGH
          - LOW
          description: The priority level of the notification. Valid values are HIGH and LOW. High priority notifications
            are displayed above low priority notifications.
        Content:
          type: object
          additionalProperties:
            type: string
          description: 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:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        PredefinedNotificationId:
          type: string
        ClientToken:
          type: string
          description: 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.
      required:
      - InstanceId
      - Recipients
      - Content
    CreateNotificationResponse:
      type: object
      properties:
        NotificationId:
          type: string
          description: The unique identifier assigned to the created notification.
        NotificationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created notification.
      required:
      - NotificationId
      - NotificationArn
    DeleteNotificationRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NotificationId:
          type: string
          description: The unique identifier for the notification to delete.
      required:
      - InstanceId
      - NotificationId
    DeleteNotificationResponse:
      type: object
      properties: {}
    DescribeNotificationRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NotificationId:
          type: string
          description: The unique identifier for the notification.
      required:
      - InstanceId
      - NotificationId
    DescribeNotificationResponse:
      type: object
      properties:
        Notification:
          $ref: '#/components/schemas/Notification'
      required:
      - Notification
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    ListNotificationsRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response to retrieve
            the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page. Valid range is 1-100.
      required:
      - InstanceId
    ListNotificationsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of results. If present, there are more results available.
        NotificationSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
          description: A list of notification summaries.
      required:
      - NotificationSummaryList
    ListUserNotificationsRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response to retrieve
            the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page. Valid range is 1-1000.
        UserId:
          type: string
          description: The identifier of the user.
      required:
      - InstanceId
      - UserId
    ListUserNotificationsResponse:
      type: object
      properties:
        UserNotifications:
          type: array
          items:
            $ref: '#/components/schemas/UserNotificationSummary'
          description: A list of notifications sent to the specified user.
        NextToken:
          type: string
          description: The token for the next set of results. If present, there are more results available.
    Notification:
      type: object
      properties:
        Content:
          type: object
          additionalProperties:
            type: string
          description: The localized content of the notification. A map where keys are locale codes and values are the notification
            text in that locale.
        Id:
          type: string
          description: The unique identifier for the notification.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the notification.
        Priority:
          type: string
          enum:
          - URGENT
          - HIGH
          - LOW
          description: The priority level of the notification. Valid values are URGENT, HIGH, and LOW.
        Recipients:
          type: array
          items:
            type: string
          description: A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200
            recipients.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the notification was last modified.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp when the notification was created.
        ExpiresAt:
          type: string
          format: date-time
          description: The timestamp when the notification expires and is no longer displayed to users.
        LastModifiedRegion:
          type: string
          description: The AWS Region where the notification was last modified.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - Id
      - Arn
      - LastModifiedTime
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateNotificationContentRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NotificationId:
          type: string
          description: The unique identifier for the notification to update.
        Content:
          type: object
          additionalProperties:
            type: string
          description: The updated localized content of the notification. A map of locale codes and values. Maximum 500 visible
            characters per locale.
      required:
      - InstanceId
      - NotificationId
      - Content
    UpdateNotificationContentResponse:
      type: object
      properties: {}
    UpdateUserNotificationStatusRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        NotificationId:
          type: string
          description: The unique identifier for the notification.
        UserId:
          type: string
          description: The identifier of the user whose notification status is being updated.
        Status:
          type: string
          enum:
          - READ
          - UNREAD
          - HIDDEN
          description: The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the notification status was last modified. Used for cross-region replication and
            optimistic locking.
        LastModifiedRegion:
          type: string
          description: The AWS Region where the notification status was last modified. Used for cross-region replication.
      required:
      - InstanceId
      - NotificationId
      - UserId
      - Status
    UpdateUserNotificationStatusResponse:
      type: object
      properties: {}
    UserNotificationSummary:
      type: object
      properties:
        NotificationId:
          type: string
          description: The unique identifier for the notification.
        NotificationStatus:
          type: string
          enum:
          - READ
          - UNREAD
          - HIDDEN
          description: The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.
        InstanceId:
          type: string
          description: The identifier of the Amazon Connect instance.
        RecipientId:
          type: string
          description: The identifier of the recipient user.
        Content:
          type: object
          additionalProperties:
            type: string
          description: The localized content of the notification.
        Priority:
          type: string
          enum:
          - URGENT
          - HIGH
          - LOW
          description: The priority level of the notification.
        Source:
          type: string
          enum:
          - CUSTOMER
          - RULES
          - SYSTEM
          description: The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp when the notification was created.
        ExpiresAt:
          type: string
          format: date-time
          description: The timestamp when the notification expires.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)