Support / Client / describe_attachment_upload_status

describe_attachment_upload_status

Support.Client.describe_attachment_upload_status(**kwargs)

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 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_attachment_upload_status(
    uploadId='string',
    dryRun=True|False
)
Parameters:

  • uploadId (string) –

    [REQUIRED]

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

  • dryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'uploadStatus': 'attachment-ready'|'attachment-not-ready'|'failed',
    'fileName': 'string',
    'uploadProgress': {
        'totalParts': 123,
        'completedPartsCount': 123
    }
}

Response Structure

  • (dict) –

    • uploadStatus (string) –

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

    • fileName (string) –

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

    • uploadProgress (dict) –

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

      • totalParts (integer) –

        The total number of parts that the file is split into.

      • completedPartsCount (integer) –

        The number of parts that have been successfully uploaded.

Exceptions