Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class AbortMultipartUploadCommandProtected

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:

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, AbortMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, AbortMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // AbortMultipartUploadRequest
Bucket: "STRING_VALUE", // required
Key: "STRING_VALUE", // required
UploadId: "STRING_VALUE", // required
RequestPayer: "requester",
ExpectedBucketOwner: "STRING_VALUE",
};
const command = new AbortMultipartUploadCommand(input);
const response = await client.send(command);
// { // AbortMultipartUploadOutput
// RequestCharged: "requester",
// };

Param

AbortMultipartUploadCommandInput

Returns

AbortMultipartUploadCommandOutput

See

Throws

NoSuchUpload (client fault)

The specified multipart upload does not exist.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To abort a multipart upload

// The following example aborts a multipart upload.
const input = {
"Bucket": "examplebucket",
"Key": "bigobject",
"UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
};
const command = new AbortMultipartUploadCommand(input);
await client.send(command);
// example id: to-abort-a-multipart-upload-1481853354987

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods