Amazon Connect Connect Related Items API

openapi: 3.1.0
info:
  title: Amazon Connect Service Related Items API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 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://cases.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{domainId}/cases/{caseId}/related-items/:
    post:
      operationId: CreateRelatedItem
      summary: Create Related Item
      description: 'Creates a related item (comments, tasks, and contacts) and associates it with a case. There''s a quota
        for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas. Use cases Following
        are examples of related items that you may want to associate with a case: Related contacts, such as calls, chats,
        emails tasks Comments, for agent notes SLAs, to capture target resolution goals Cases, to capture related Connect
        Customer Cases Files, such as policy documentation or customer-provided attachments Custom related items, which provide
        flexibility for you to define related items that such as bookings, orders, products, notices, and more Important things
        to know If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact
        permission on the ARN of the contact that you provide in content.contact.contactArn. A Related Item is a resource
        that is associated with a case. It may or may not have an external identifier linking it to an external resource (for
        example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related
        items include comments and contacts. If you pr'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRelatedItemResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRelatedItemRequest'
      tags:
      - Related Items
  /domains/{domainId}/cases/{caseId}/related-items/{relatedItemId}:
    put:
      operationId: UpdateRelatedItem
      summary: Update Related Item
      description: 'Updates the content of a related item associated with a case. The following related item types are supported:
        Comment - Update the text content of an existing comment Custom - Update the fields of a custom related item. You
        can add, modify, and remove fields from a custom related item. There''s a quota for the number of fields allowed in
        a Custom type related item. See Connect Customer Cases quotas. Important things to know When updating a Custom related
        item, all existing and new fields, and their associated values should be included in the request. Fields not included
        as part of this request will be removed. If you provide a value for performedBy.userArn, you must also have DescribeUser
        permission on the ARN of the user that you provide. System case fields cannot be used in a custom related item. If
        the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information,
        see StartMergeCases. Endpoints: See Connect Customer endpoints and quotas.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRelatedItemResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRelatedItemRequest'
      tags:
      - Related Items
    delete:
      operationId: DeleteRelatedItem
      summary: Delete Related Item
      description: Deletes the related item resource under a case. This API cannot be used on a FILE type related attachment.
        To delete this type of file, use the DeleteAttachedFile API If the case is the secondary case of a merge that is running,
        the request fails with a ConflictException. For more information, see StartMergeCases.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRelatedItemResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CasesThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRelatedItemRequest'
      tags:
      - Related Items
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: cases
  schemas:
    CasesAccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesContact:
      type: object
      properties:
        contactArn:
          type: string
          description: A unique identifier of a contact in Connect Customer.
      required:
      - contactArn
    CasesFieldValue:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of a field.
        value:
          $ref: '#/components/schemas/CasesFieldValueUnion'
      required:
      - id
      - value
    CasesFieldValueUnion:
      type: object
      properties:
        stringValue:
          type: string
          description: String value type.
        doubleValue:
          type: number
          description: Can be either null, or have a Double number value type. Only one value can be provided.
        booleanValue:
          type: boolean
          description: Can be either null, or have a Boolean value type. Only one value can be provided.
        emptyValue:
          $ref: '#/components/schemas/EmptyFieldValue'
        userArnValue:
          type: string
          description: Represents the user that performed the audit.
      description: Exactly one member is set.
    CasesResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: Unique identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    CasesServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CasesThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CommentContent:
      type: object
      properties:
        body:
          type: string
          description: Text in the body of a Comment on a case.
        contentType:
          type: string
          description: Type of the text in the box of a Comment on a case.
      required:
      - body
      - contentType
    CommentUpdateContent:
      type: object
      properties:
        body:
          type: string
          description: Updated text in the body of a Comment on a case.
        contentType:
          type: string
          description: Type of the text in the box of a Comment on a case.
      required:
      - body
      - contentType
    ConnectCaseContent:
      type: object
      properties:
        caseId:
          type: string
          description: A unique identifier of the case.
      required:
      - caseId
    ConnectCaseInputContent:
      type: object
      properties:
        caseId:
          type: string
          description: A unique identifier of the case.
      required:
      - caseId
    ContactContent:
      type: object
      properties:
        contactArn:
          type: string
          description: A unique identifier of a contact in Connect Customer.
        channel:
          type: string
          description: A list of channels to filter on for related items of type Contact.
        connectedToSystemTime:
          type: string
          format: date-time
          description: The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.
      required:
      - contactArn
      - channel
      - connectedToSystemTime
    CreateRelatedItemRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        caseId:
          type: string
          description: A unique identifier of the case.
        type:
          type: string
          description: The type of a related item.
        content:
          $ref: '#/components/schemas/RelatedItemInputContent'
        performedBy:
          $ref: '#/components/schemas/UserUnion'
      required:
      - domainId
      - caseId
      - type
      - content
    CreateRelatedItemResponse:
      type: object
      properties:
        relatedItemId:
          type: string
          description: The unique identifier of the related item.
        relatedItemArn:
          type: string
          description: The Amazon Resource Name (ARN) of the related item.
      required:
      - relatedItemId
      - relatedItemArn
    CustomContent:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CasesFieldValue'
          description: List of field values for the Custom related item.
      required:
      - fields
    CustomInputContent:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CasesFieldValue'
          description: List of field values for the Custom related item.
      required:
      - fields
    CustomUpdateContent:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CasesFieldValue'
          description: List of updated field values for the Custom related item. All existing and new fields, and their associated
            values should be included. Fields not included as part of this request will be removed.
      required:
      - fields
    DeleteRelatedItemRequest:
      type: object
      properties:
        domainId:
          type: string
          description: A unique identifier of the Cases domain.
        caseId:
          type: string
          description: A unique identifier of the case.
        relatedItemId:
          type: string
          description: A unique identifier of a related item.
      required:
      - domainId
      - caseId
      - relatedItemId
    DeleteRelatedItemResponse:
      type: object
      properties: {}
    EmptyFieldValue:
      type: object
      properties: {}
    FileContent:
      type: object
      properties:
        fileArn:
          type: string
          description: The Amazon Resource Name (ARN) of a File in Connect Customer.
      required:
      - fileArn
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    RelatedItemContent:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ContactContent'
        comment:
          $ref: '#/components/schemas/CommentContent'
        file:
          $ref: '#/components/schemas/FileContent'
        sla:
          $ref: '#/components/schemas/SlaContent'
        connectCase:
          $ref: '#/components/schemas/ConnectCaseContent'
        custom:
          $ref: '#/components/schemas/CustomContent'
      description: Exactly one member is set.
    RelatedItemInputContent:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/CasesContact'
        comment:
          $ref: '#/components/schemas/CommentContent'
        file:
          $ref: '#/components/schemas/FileContent'
        sla:
          $ref: '#/components/schemas/SlaInputContent'
        connectCase:
          $ref: '#/components/schemas/ConnectCaseInputContent'
        custom:
          $ref: '#/components/schemas/CustomInputContent'
      description: Exactly one member is set.
    RelatedItemUpdateContent:
      type: object
      properties:
        comment:
          $ref: '#/components/schemas/CommentUpdateContent'
        custom:
          $ref: '#/components/schemas/CustomUpdateContent'
      description: Exactly one member is set.
    SlaConfiguration:
      type: object
      properties:
        name:
          type: string
          description: Name of an SLA.
        type:
          type: string
          description: Type of SLA.
        status:
          type: string
          description: Status of an SLA.
        fieldId:
          type: string
          description: Unique identifier of a field.
        targetFieldValues:
          type: array
          items:
            $ref: '#/components/schemas/CasesFieldValueUnion'
          description: Represents a list of target field values for the fieldId specified in SlaConfiguration.
        targetTime:
          type: string
          format: date-time
          description: Target time by which an SLA should be completed.
        completionTime:
          type: string
          format: date-time
          description: Time at which an SLA was completed.
      required:
      - name
      - type
      - status
      - targetTime
    SlaContent:
      type: object
      properties:
        slaConfiguration:
          $ref: '#/components/schemas/SlaConfiguration'
      required:
      - slaConfiguration
    SlaInputConfiguration:
      type: object
      properties:
        name:
          type: string
          description: Name of an SLA.
        type:
          type: string
          description: Type of SLA.
        fieldId:
          type: string
          description: Unique identifier of a field.
        targetFieldValues:
          type: array
          items:
            $ref: '#/components/schemas/CasesFieldValueUnion'
          description: Represents a list of target field values for the fieldId specified in SlaInputConfiguration. The SLA
            is considered met if any one of these target field values matches the actual field value.
        targetSlaMinutes:
          type: integer
          description: Target duration in minutes within which an SLA should be completed.
      required:
      - name
      - type
      - targetSlaMinutes
    SlaInputContent:
      type: object
      properties:
        slaInputConfiguration:
          $ref: '#/components/schemas/SlaInputConfiguration'
      description: Exactly one member is set.
    UpdateRelatedItemRequest:
      type: object
      properties:
        domainId:
          type: string
          description: The unique identifier of the Cases domain.
        caseId:
          type: string
          description: A unique identifier of the case.
        relatedItemId:
          type: string
          description: Unique identifier of a related item.
        content:
          $ref: '#/components/schemas/RelatedItemUpdateContent'
        performedBy:
          $ref: '#/components/schemas/UserUnion'
      required:
      - domainId
      - caseId
      - relatedItemId
      - content
    UpdateRelatedItemResponse:
      type: object
      properties:
        relatedItemId:
          type: string
          description: The unique identifier of the updated related item.
        relatedItemArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated related item.
        type:
          type: string
          description: Type of the updated related item.
        content:
          $ref: '#/components/schemas/RelatedItemContent'
        associationTime:
          type: string
          format: date-time
          description: Time at which the related item was associated with the case.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control
            access for this resource.
        lastUpdatedUser:
          $ref: '#/components/schemas/UserUnion'
        createdBy:
          $ref: '#/components/schemas/UserUnion'
      required:
      - relatedItemId
      - relatedItemArn
      - type
      - content
      - associationTime
    UserUnion:
      type: object
      properties:
        userArn:
          type: string
          description: Represents the Connect Customer ARN of the user.
        customEntity:
          type: string
          description: Any provided entity.
      description: Exactly one member is set.
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcases/service/2022-10-03/connectcases-2022-10-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)