deleteMultipleObjects method

Deletes objects based on a list of keys passed in a request.

It takes less time than deleting the same objects one by one via separate requests.

The delete list may contain up to 1,000 keys.

If an object does not exist, Object Storage marks it as deleted in the response.

You can configure responses so that Object Storage returns one of the following selections:

• Statuses of all delete operations.
• Only statuses with errors deleting objects. In this case, if no errors occurred, an empty response is returned.

For more information on getting started with the API and the general request format, see How to use the S3 API.

RequestRequest

POST /{bucket}?delete HTTP/2

Path parametersPath parameters

Query parametersQuery parameters

HeadersHeaders

Use the appropriate common headers in your request.

For this request, the Content-MD5 and Content-Length headers are required.

Moreover, if governance-mode retention is put on object versions in a versioned bucket, make sure to use the below-specified header to bypass retention and confirm deletion. Only users with the storage.admin role can delete a retained object version. To check retention status, use the getObjectRetention method.

Data schemaData schema

The list of keys to delete is passed in XML format.

<?xml version="1.0" encoding="UTF-8"?>
<Delete>
    <Quiet>true</Quiet>
    <Object>
         <Key>Key</Key>
    </Object>
    ...
</Delete>

ResponseResponse

HeadersHeaders

Responses can only contain common response headers.

Response codesResponse codes

For a list of possible responses, see Responses.

A successful response contains additional data in XML format with the schema described below.

Data structureData structure

<DeleteResult>
  <Deleted>
    <Key>some/key.txt</Key>
  </Deleted>
  <Error>
    <Key>some/another/key.txt</Key>
    <Code>TextErrorCode</Code>
    <Message>Describing message</Message>
  </Error>
</DeleteResult>

See alsoSee also

• Debugging requests using the AWS CLI
• Example of sending a signed request using curl
• Example of signature generation code