Skip to content

Start Attachment Upload

connectparticipant_start_attachment_upload R Documentation

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3

Description

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Usage

connectparticipant_start_attachment_upload(ContentType,
  AttachmentSizeInBytes, AttachmentName, ClientToken, ConnectionToken)

Arguments

ContentType

[required] Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

AttachmentSizeInBytes

[required] The size of the attachment in bytes.

AttachmentName

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

ClientToken

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

ConnectionToken

[required] The authentication token associated with the participant's connection.

Value

A list with the following syntax:

list(
  AttachmentId = "string",
  UploadMetadata = list(
    Url = "string",
    UrlExpiry = "string",
    HeadersToInclude = list(
      "string"
    )
  )
)

Request syntax

svc$start_attachment_upload(
  ContentType = "string",
  AttachmentSizeInBytes = 123,
  AttachmentName = "string",
  ClientToken = "string",
  ConnectionToken = "string"
)