paws.storage (version 0.1.7)

s3_abort_multipart_upload: This operation aborts a multipart upload

Description

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

Usage

s3_abort_multipart_upload(Bucket, Key, UploadId, RequestPayer)

Arguments

Bucket

[required] The bucket name to which the upload was taking place.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

Key

[required] Key of the object for which the multipart upload was initiated.

UploadId

[required] Upload ID that identifies the multipart upload.

RequestPayer

Request syntax

svc$abort_multipart_upload(
  Bucket = "string",
  Key = "string",
  UploadId = "string",
  RequestPayer = "requester"
)

Details

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

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

The following operations are related to AbortMultipartUpload:

• CreateMultipartUpload

• UploadPart

• CompleteMultipartUpload

• ListParts

• ListMultipartUploads

Examples

# NOT RUN {
# The following example aborts a multipart upload.
# }
# NOT RUN {
svc$abort_multipart_upload(
  Bucket = "examplebucket",
  Key = "bigobject",
  UploadId = "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP..."
)
# }
# NOT RUN {
# }