abort_multipart_upload

S3.Client.abort_multipart_upload(**kwargs)

This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty.

For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.

The following operations are related to AbortMultipartUpload :

• CreateMultipartUpload
• UploadPart
• CompleteMultipartUpload
• ListParts
• ListMultipartUploads

See also: AWS API Documentation

Request Syntax

response = client.abort_multipart_upload(
    Bucket='string',
    Key='string',
    UploadId='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string'
)

Parameters

• Bucket (string) --

  [REQUIRED]

  The bucket name to which the upload was taking place.

  When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName -AccountId .s3-accesspoint.*Region* .amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide .

  When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide .

• Key (string) --

  [REQUIRED]

  Key of the object for which the multipart upload was initiated.

• UploadId (string) --

  [REQUIRED]

  Upload ID that identifies the multipart upload.

• RequestPayer (string) -- Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .
• ExpectedBucketOwner (string) -- The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type

dict

Returns

Response Syntax

{
    'RequestCharged': 'requester'
}

Response Structure

• (dict) --

  • RequestCharged (string) --

    If present, indicates that the requester was successfully charged for the request.

Exceptions

• S3.Client.exceptions.NoSuchUpload

Examples

The following example aborts a multipart upload.

response = client.abort_multipart_upload(
    Bucket='examplebucket',
    Key='bigobject',
    UploadId='xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}