Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartAttachmentUpload

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

For security recommendations, see Amazon Connect Chat security best practices.

Note

ConnectionToken is used for invoking this API instead of ParticipantToken.

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

Request Syntax


POST /participant/start-attachment-upload HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "AttachmentName": "string",
   "AttachmentSizeInBytes": number,
   "ClientToken": "string",
   "ContentType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ConnectionToken

The authentication token associated with the participant's connection.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AttachmentName

A case-sensitive name of the attachment being uploaded.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

AttachmentSizeInBytes

The size of the attachment in bytes.

Type: Long

Valid Range: Minimum value of 1.

Required: Yes

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

ContentType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AttachmentId": "string",
   "UploadMetadata": { 
      "HeadersToInclude": { 
         "string" : "string" 
      },
      "Url": "string",
      "UrlExpiry": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AttachmentId

A unique identifier for the attachment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

UploadMetadata

Fields to be used while uploading the attachment.

Type: UploadMetadata object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the Amazon Connect service.

HTTP Status Code: 500

ServiceQuotaExceededException

The number of attachments per contact exceeds the quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by Amazon Connect.

HTTP Status Code: 400