Skip to content

Completes an attachment upload that was started with GetAttachmentUploadLinks

Description

Completes an attachment upload that was started with get_attachment_upload_links. After you upload a part of the file to its presigned Amazon S3 URL, call complete_attachment_upload with the partIndex and eTag of that part. You can include one part per call, or multiple parts in a single call. After complete_attachment_upload has been called for every part of the file, the service processes the upload asynchronously. The attachment-ready status might not be reflected immediately. Use describe_attachment_upload_status to poll for the uploadStatus to become attachment-ready before passing the uploadId to create_case or add_communication_to_case.

Usage

support_complete_attachment_upload(uploadId, completedUploads, dryRun)

Arguments

  • uploadId

[required] The identifier associated with the upload to complete.

  • completedUploads

[required] The list of parts being reported as completed in this call. Each entry must contain the partIndex of an uploaded part and the ETag returned by Amazon S3 when that part was uploaded.

  • dryRun

Specifies whether to validate the request without actually completing the upload. When set to true, the request is validated but the upload isn't finalized, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Value

A list with the following syntax:

list(
  uploadStatus = "attachment-ready"|"attachment-not-ready"|"failed"
)

Request syntax

svc$complete_attachment_upload(
  uploadId = "string",
  completedUploads = list(
    list(
      partIndex = 123,
      eTag = "string"
    )
  ),
  dryRun = TRUE|FALSE
)