Skip to content

Provides a pre-signed Amazon S3 URL in response for uploading your content

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.

Usage

connect_start_attached_file_upload(ClientToken, InstanceId, FileName,
  FileSizeInBytes, UrlExpiryInSeconds, FileUseCaseType,
  AssociatedResourceArn, CreatedBy, Tags)

Arguments

  • ClientToken

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  • InstanceId

    [required] The unique identifier of the Connect Customer instance.

  • FileName

    [required] A case-sensitive name of the attached file being uploaded.

  • FileSizeInBytes

    [required] The size of the attached file in bytes.

  • UrlExpiryInSeconds

    Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

  • FileUseCaseType

    [required] The use case for the file.

    Only ATTACHMENTS are supported.

  • AssociatedResourceArn

    [required] 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

    Represents the identity that created the file.

  • Tags

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

Value

A list with the following syntax:

list(
  FileArn = "string",
  FileId = "string",
  CreationTime = "string",
  FileStatus = "APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
  CreatedBy = list(
    ConnectUserArn = "string",
    AWSIdentityArn = "string"
  ),
  UploadUrlMetadata = list(
    Url = "string",
    UrlExpiry = "string",
    HeadersToInclude = list(
      "string"
    )
  )
)

Request syntax

svc$start_attached_file_upload(
  ClientToken = "string",
  InstanceId = "string",
  FileName = "string",
  FileSizeInBytes = 123,
  UrlExpiryInSeconds = 123,
  FileUseCaseType = "CONTACT_ANALYSIS"|"EMAIL_MESSAGE"|"EMAIL_MESSAGE_PLAIN_TEXT"|"EMAIL_MESSAGE_REDACTED"|"EMAIL_MESSAGE_PLAIN_TEXT_REDACTED"|"ATTACHMENT"|"VOICE_RECORDING",
  AssociatedResourceArn = "string",
  CreatedBy = list(
    ConnectUserArn = "string",
    AWSIdentityArn = "string"
  ),
  Tags = list(
    "string"
  )
)