Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAttachmentUploadStatus

Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through CompleteAttachmentUpload, 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 CreateCase or AddCommunicationToCase.

Note

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

Request Syntax


{
   "dryRun": boolean,
   "uploadId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: Boolean

uploadId

The unique identifier for the upload. The uploadId is returned by GetAttachmentUploadLinks when you initiate the upload.

Type: String

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

Response Syntax


{
   "fileName": "string",
   "uploadProgress": { 
      "completedPartsCount": number,
      "totalParts": number
   },
   "uploadStatus": "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.

fileName

The name of the file being uploaded, including the file extension.

Type: String

uploadProgress

The progress of the multipart upload, including the total number of parts and the number of parts that have been successfully uploaded.

Type: UploadProgress object

uploadStatus

The current status of the multipart upload. Valid values: attachment-ready, attachment-not-ready, and failed.

Type: String

Valid Values: attachment-ready | attachment-not-ready | failed

Errors

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

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500

UploadIdNotFound

The specified uploadId couldn't be located.

HTTP Status Code: 400