Amazon Connect Connect Attached Files API

openapi: 3.1.0
info:
  title: Amazon Connect Service Attached Files API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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:
  /attached-files/{InstanceId}:
    post:
      operationId: BatchGetAttachedFileMetadata
      summary: Batch Get Attached File Metadata
      description: Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached
        file provided in the input list must be associated with the input AssociatedResourceArn.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetAttachedFileMetadataResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/BatchGetAttachedFileMetadataRequest'
      tags:
      - Attached Files
    put:
      operationId: StartAttachedFileUpload
      summary: Start Attached File Upload
      description: Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to
        upload attachments to a Connect Customer Case, Connect Customer Email, or Connect Customer Task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartAttachedFileUploadResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartAttachedFileUploadRequest'
      tags:
      - Attached Files
  /attached-files/{InstanceId}/{FileId}:
    post:
      operationId: CompleteAttachedFileUpload
      summary: Complete Attached File Upload
      description: Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the
        StartAttachedFileUpload API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompleteAttachedFileUploadResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/CompleteAttachedFileUploadRequest'
      tags:
      - Attached Files
    delete:
      operationId: DeleteAttachedFile
      summary: Delete Attached File
      description: Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted
        if S3 bucket versioning is not enabled.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAttachedFileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/DeleteAttachedFileRequest'
      tags:
      - Attached Files
    get:
      operationId: GetAttachedFile
      summary: Get Attached File
      description: Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about
        the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAttachedFileResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/GetAttachedFileRequest'
      tags:
      - Attached Files
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
    AttachedFile:
      type: object
      properties:
        CreationTime:
          type: string
          description: 'The time of Creation of the file resource as an ISO timestamp. It''s specified in ISO 8601 format:
            yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.'
        FileArn:
          type: string
          description: The unique identifier of the attached file resource (ARN).
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        FileName:
          type: string
          description: A case-sensitive name of the attached file being uploaded.
        FileSizeInBytes:
          type: integer
          description: The size of the attached file in bytes.
        FileStatus:
          type: string
          enum:
          - APPROVED
          - REJECTED
          - PROCESSING
          - FAILED
          - DRAFTING
          description: The current status of the attached file.
        CreatedBy:
          $ref: '#/components/schemas/CreatedByInfo'
        FileUseCaseType:
          type: string
          enum:
          - CONTACT_ANALYSIS
          - EMAIL_MESSAGE
          - EMAIL_MESSAGE_PLAIN_TEXT
          - EMAIL_MESSAGE_REDACTED
          - EMAIL_MESSAGE_PLAIN_TEXT_REDACTED
          - ATTACHMENT
          - VOICE_RECORDING
          description: The use case for the file.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
        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:
      - CreationTime
      - FileArn
      - FileId
      - FileName
      - FileSizeInBytes
      - FileStatus
    AttachedFileError:
      type: object
      properties:
        ErrorCode:
          type: string
          description: Status code describing the failure.
        ErrorMessage:
          type: string
          description: Why the attached file couldn't be retrieved.
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
    BatchGetAttachedFileMetadataRequest:
      type: object
      properties:
        FileIds:
          type: array
          items:
            type: string
          description: The unique identifiers of the attached file resource.
        InstanceId:
          type: string
          description: The unique identifier of the Connect instance.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
      required:
      - FileIds
      - InstanceId
      - AssociatedResourceArn
    BatchGetAttachedFileMetadataResponse:
      type: object
      properties:
        Files:
          type: array
          items:
            $ref: '#/components/schemas/AttachedFile'
          description: List of attached files that were successfully retrieved.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/AttachedFileError'
          description: List of errors of attached files that could not be retrieved.
    CompleteAttachedFileUploadRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier of the Connect Customer instance.
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
      required:
      - InstanceId
      - FileId
      - AssociatedResourceArn
    CompleteAttachedFileUploadResponse:
      type: object
      properties: {}
    CreatedByInfo:
      type: object
      properties:
        ConnectUserArn:
          type: string
          description: An agent ARN representing a connect user.
        AWSIdentityArn:
          type: string
          description: STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value
            is calculated automatically if ConnectUserArn is not provided.
      description: Exactly one member is set.
    DeleteAttachedFileRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier of the Connect instance.
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
      required:
      - InstanceId
      - FileId
      - AssociatedResourceArn
    DeleteAttachedFileResponse:
      type: object
      properties: {}
    DownloadUrlMetadata:
      type: object
      properties:
        Url:
          type: string
          description: A pre-signed URL that should be used to download the attached file.
        UrlExpiry:
          type: string
          description: 'The expiration time of the URL in ISO timestamp. It''s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ.
            For example, 2019-11-08T02:41:28.172Z.'
    GetAttachedFileRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier of the Connect Customer instance.
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        UrlExpiryInSeconds:
          type: integer
          description: Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
        UrlContentDisposition:
          type: string
          enum:
          - INLINE
          - ATTACHMENT
          description: 'Specifies how a browser handles the file at the pre-signed URL. The valid values are the following:
            INLINE Displays the file in the browser. ATTACHMENT Downloads the file. This is the default.'
      required:
      - InstanceId
      - FileId
      - AssociatedResourceArn
    GetAttachedFileResponse:
      type: object
      properties:
        FileArn:
          type: string
          description: The unique identifier of the attached file resource (ARN).
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        CreationTime:
          type: string
          description: 'The time of Creation of the file resource as an ISO timestamp. It''s specified in ISO 8601 format:
            yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.'
        FileStatus:
          type: string
          enum:
          - APPROVED
          - REJECTED
          - PROCESSING
          - FAILED
          - DRAFTING
          description: The current status of the attached file.
        FileName:
          type: string
          description: A case-sensitive name of the attached file being uploaded.
        FileSizeInBytes:
          type: integer
          description: The size of the attached file in bytes.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task.
        FileUseCaseType:
          type: string
          enum:
          - CONTACT_ANALYSIS
          - EMAIL_MESSAGE
          - EMAIL_MESSAGE_PLAIN_TEXT
          - EMAIL_MESSAGE_REDACTED
          - EMAIL_MESSAGE_PLAIN_TEXT_REDACTED
          - ATTACHMENT
          - VOICE_RECORDING
          description: The use case for the file.
        CreatedBy:
          $ref: '#/components/schemas/CreatedByInfo'
        DownloadUrlMetadata:
          $ref: '#/components/schemas/DownloadUrlMetadata'
        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:
      - FileSizeInBytes
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the request.
        Reason:
          $ref: '#/components/schemas/InvalidRequestExceptionReason'
    InvalidRequestExceptionReason:
      type: object
      properties:
        AttachedFileInvalidRequestExceptionReason:
          type: string
          enum:
          - INVALID_FILE_SIZE
          - INVALID_FILE_TYPE
          - INVALID_FILE_NAME
          description: Reason why the StartAttachedFiledUpload request was invalid.
      description: Exactly one member is set.
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          $ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
    ServiceQuotaExceededExceptionReason:
      type: object
      properties:
        AttachedFileServiceQuotaExceededExceptionReason:
          type: string
          enum:
          - TOTAL_FILE_SIZE_EXCEEDED
          - TOTAL_FILE_COUNT_EXCEEDED
          description: Total file size of all files or total number of files exceeds the service quota
      description: Exactly one member is set.
    StartAttachedFileUploadRequest:
      type: object
      properties:
        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.
        InstanceId:
          type: string
          description: The unique identifier of the Connect Customer instance.
        FileName:
          type: string
          description: A case-sensitive name of the attached file being uploaded.
        FileSizeInBytes:
          type: integer
          description: The size of the attached file in bytes.
        UrlExpiryInSeconds:
          type: integer
          description: Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
        FileUseCaseType:
          type: string
          enum:
          - CONTACT_ANALYSIS
          - EMAIL_MESSAGE
          - EMAIL_MESSAGE_PLAIN_TEXT
          - EMAIL_MESSAGE_REDACTED
          - EMAIL_MESSAGE_PLAIN_TEXT_REDACTED
          - ATTACHMENT
          - VOICE_RECORDING
          description: The use case for the file. Only ATTACHMENTS are supported.
        AssociatedResourceArn:
          type: string
          description: The resource to which the attached file is (being) uploaded to. The supported resources are Cases,
            Email, and Task. This value must be a valid ARN.
        CreatedBy:
          $ref: '#/components/schemas/CreatedByInfo'
        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:
      - InstanceId
      - FileName
      - FileSizeInBytes
      - FileUseCaseType
      - AssociatedResourceArn
    StartAttachedFileUploadResponse:
      type: object
      properties:
        FileArn:
          type: string
          description: The unique identifier of the attached file resource (ARN).
        FileId:
          type: string
          description: The unique identifier of the attached file resource.
        CreationTime:
          type: string
          description: 'The time of Creation of the file resource as an ISO timestamp. It''s specified in ISO 8601 format:
            yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.'
        FileStatus:
          type: string
          enum:
          - APPROVED
          - REJECTED
          - PROCESSING
          - FAILED
          - DRAFTING
          description: The current status of the attached file.
        CreatedBy:
          $ref: '#/components/schemas/CreatedByInfo'
        UploadUrlMetadata:
          $ref: '#/components/schemas/UploadUrlMetadata'
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UploadUrlMetadata:
      type: object
      properties:
        Url:
          type: string
          description: A pre-signed S3 URL that should be used for uploading the attached file.
        UrlExpiry:
          type: string
          description: 'The expiration time of the URL in ISO timestamp. It''s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ.
            For example, 2019-11-08T02:41:28.172Z.'
        HeadersToInclude:
          type: object
          additionalProperties:
            type: string
          description: A map of headers that should be provided when uploading the attached file.
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)