abort-multipart-upload

Available in Classic and VPC

Stop an ongoing multipart upload. Once a multipart upload has been stopped, you can't upload parts using the upload ID.

Commands

The command statement is as follows:

aws s3api abort-multipart-upload --bucket <value> --key <value> --upload-id <value> [--options]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
--bucket <value>	string	Y	Specify the bucket for uploading large objects using multipart upload.	-
--key <value>	string	Y	Specify the name (key value) of the object to upload.	-
--upload-id <value>	string	Y	ID that identifies multipart uploads	-
--endpoint-url <value>	string	Y	Specify the default URL for command calls.	It is only available for the KR Region. See Ncloud Storage overview for call domain information.
--cli-input-json \| --cli-input-yaml	string	N	Enter arguments from the provided json or yaml string.	You can't specify json and yaml together.
--generate-cli-skeleton <value>	integer	N	Create a parameter template that can be used as input later without executing the API command.	-
--debug	boolean	N	Use debug logging.	-
--no-verify-ssl	boolean	N	Redefine the default behavior for validating SSL certificates.	-
--no-paginate	boolean	N	Disable automatic pagination, call only the first page for results.	-
--output <value>	string	N	Specify the format of response results.	Available options json text table yaml yaml-stream
--query <value>	string	N	JMESPath query to use for filtering response data	-
--profile <value>	string	N	Use a specific profile in the credentials file.	-
--region <value>	string	N	Specify the Region.	Only KR is supported.
--color <value>	string	N	Set output color.	Available options on off auto
--no-sign-request	boolean	N	Disable credential loading.	-
--ca-bundle <value>	string	N	Specify the CA certificate to use when verifying SSL certificates.	-
--cli-read-timeout <value>	int	N	Maximum read time; entering 0 changes it to a blocked status instead of a timeout.	It is set to 60 seconds by default.
--cli-connect-timeout <value>	int	N	Maximum connection time; entering 0 changes it to a blocked status instead of a timeout.	It is set to 60 seconds by default.
--no-cli-pager	boolean	N	Disable the CLI pager for response values.	-
--cli-auto-prompt	boolean	N	Enable automatic prompting for CLI input parameters.	-
--no-cli-auto-prompt	boolean	N	Disable automatic prompting for CLI input parameters.	-

Permission

If a sub account user wants to use this command, they need the Change/AbortMultipartUpload action permission.

Examples

This section describes an example of calling and responding to the abort-multipart-upload command.

Stop multipart upload

Call examples

If you specify the bucket, key, and upload ID of the multipart upload to stop uploading, and then call the command, multipart uploading will be stopped and the relevant parts will be deleted. The following is a call example.

aws s3api abort-multipart-upload --endpoint-url=http://kr.ncloudstorage.com --bucket bucket-a --key 'multipart/01' --upload-id a1b23c4d-e56f-78gh-9101-1ij2k345l789

Response example

The response example is as follows:

{
    "Bucket": "bucket-a",
    "Key": "multipart/01",
    "UploadId": "a1b23c4d-e56f-78gh-9101-1ij2k345l789"
}

Caution

Even if you stop a multipart upload, previously requested parts may still be uploaded and remain in storage. To ensure that all parts have been completely removed and to avoid unnecessary charges, we recommend calling the ListParts API to verify that all parts are empty.

Related commands

Related commands are as follows: