Skip to content

Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks

Description

Returns the current status, file name, and progress of a multipart attachment upload that was started with get_attachment_upload_links. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through complete_attachment_upload, the uploadStatus is attachment-not-ready and uploadProgress reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the uploadStatus becomes attachment-ready and the uploadId can be attached to a case through create_case or add_communication_to_case.

  • You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
  • If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Usage

support_describe_attachment_upload_status(uploadId, dryRun)

Arguments

  • uploadId

[required] The unique identifier for the upload. The uploadId is returned by get_attachment_upload_links when you initiate the upload.

  • dryRun

Specifies whether to validate the request without actually returning upload status. When set to true, the request is validated but no status is returned, 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",
  fileName = "string",
  uploadProgress = list(
    totalParts = 123,
    completedPartsCount = 123
  )
)

Request syntax

svc$describe_attachment_upload_status(
  uploadId = "string",
  dryRun = TRUE|FALSE
)