Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Deleting objects in Amazon S3 on Outposts buckets
Objects are the fundamental entities stored in Amazon S3 on Outposts. Every object is contained in a bucket.
You must use access points to access any object in an Outpost bucket. When you specify the bucket for object operations, you use the
access point Amazon Resource Name (ARN) or the access point alias. For more information about access point aliases, see Using a bucket-style alias for your
S3 on Outposts bucket access point.
The following example shows the
ARN format for S3 on Outposts access points, which includes the Amazon Web Services Region code for the Region that the Outpost is homed to, the Amazon Web Services account ID,
the Outpost ID, and the access point name:
arn:aws-cn:s3-outposts:region:account-id:outpost/outpost-id/accesspoint/accesspoint-name
For more information about S3 on Outposts ARNs, see Resource ARNs for S3 on Outposts.
With Amazon S3 on Outposts, object data is always stored on the Outpost. When Amazon installs an Outpost rack, your data stays local to
your Outpost to meet data-residency requirements. Your objects never leave your
Outpost and are not in an Amazon Web Services Region. Because the Amazon Web Services Management Console is hosted in-Region, you can't use the console to upload or manage objects in
your Outpost. However, you can use the REST API, Amazon Command Line Interface (Amazon CLI), and Amazon SDKs to upload and manage your objects through your access points.
The following examples show you how to delete a single object or multiple objects in an
S3 on Outposts bucket by using the Amazon Command Line Interface (Amazon CLI) and Amazon SDK for Java.
The following examples show you how to delete a single object or multiple objects
from an S3 on Outposts bucket.
- delete-object
-
The following example deletes an object named
sample-object.xml from an S3 on Outposts bucket
(s3-outposts:DeleteObject) by using the Amazon CLI. To use
this command, replace each user input
placeholder
aws s3api delete-object --bucket arn:aws-cn:s3-outposts:region:123456789012:outpost/op-01ac5d28a6a232904/accesspoint/example-outposts-access-point --key sample-object.xml
- delete-objects
-
The following example deletes two objects named
sample-object.xml and
test1.text from an S3 on Outposts bucket
(s3-outposts:DeleteObject) by using the Amazon CLI. To use
this command, replace each user input
placeholder
aws s3api delete-objects --bucket arn:aws-cn:s3-outposts:region:123456789012:outpost/op-01ac5d28a6a232904/accesspoint/example-outposts-access-point --delete file://delete.json
delete.json
{
"Objects": [
{
"Key": "test1.txt"
},
{
"Key": "sample-object.xml"
}
],
"Quiet": false
}
The following examples show you how to delete a single object or multiple objects
from an S3 on Outposts bucket.
- DeleteObject
-
The following S3 on Outposts example deletes an object in a bucket by
using the SDK for Java. To use this example, specify the access point ARN for
the Outpost and the key name for the object that you want to delete. For
more information, see DeleteObject
in the Amazon Simple Storage Service API Reference.
import com.amazonaws.AmazonServiceException;
import com.amazonaws.SdkClientException;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import com.amazonaws.services.s3.model.DeleteObjectRequest;
public class DeleteObject {
public static void main(String[] args) {
String accessPointArn = "*** access point ARN ***";
String keyName = "*** key name ****";
try {
// This code expects that you have Amazon credentials set up per:
// https://docs.amazonaws.cn/sdk-for-java/v1/developer-guide/setup-credentials.html
AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
.enableUseArnRegion()
.build();
s3Client.deleteObject(new DeleteObjectRequest(accessPointArn, keyName));
} catch (AmazonServiceException e) {
// The call was transmitted successfully, but Amazon S3 couldn't process
// it, so it returned an error response.
e.printStackTrace();
} catch (SdkClientException e) {
// Amazon S3 couldn't be contacted for a response, or the client
// couldn't parse the response from Amazon S3.
e.printStackTrace();
}
}
}
- DeleteObjects
-
The following S3 on Outposts example uploads and then deletes objects in
a bucket by using the SDK for Java. To use this example, specify the access
point ARN for the Outpost. For more information, see DeleteObjects in the
Amazon Simple Storage Service API Reference.
import com.amazonaws.AmazonServiceException;
import com.amazonaws.SdkClientException;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import com.amazonaws.services.s3.model.DeleteObjectsRequest;
import com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion;
import com.amazonaws.services.s3.model.DeleteObjectsResult;
import java.util.ArrayList;
public class DeleteObjects {
public static void main(String[] args) {
String accessPointArn = "arn:aws-cn:s3-outposts:region:123456789012:outpost/op-01ac5d28a6a232904/accesspoint/example-outposts-access-point";
try {
// This code expects that you have Amazon credentials set up per:
// https://docs.amazonaws.cn/sdk-for-java/v1/developer-guide/setup-credentials.html
AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
.enableUseArnRegion()
.build();
// Upload three sample objects.
ArrayList<KeyVersion> keys = new ArrayList<KeyVersion>();
for (int i = 0; i < 3; i++) {
String keyName = "delete object example " + i;
s3Client.putObject(accessPointArn, keyName, "Object number " + i + " to be deleted.");
keys.add(new KeyVersion(keyName));
}
System.out.println(keys.size() + " objects successfully created.");
// Delete the sample objects.
DeleteObjectsRequest multiObjectDeleteRequest = new DeleteObjectsRequest(accessPointArn)
.withKeys(keys)
.withQuiet(false);
// Verify that the objects were deleted successfully.
DeleteObjectsResult delObjRes = s3Client.deleteObjects(multiObjectDeleteRequest);
int successfulDeletes = delObjRes.getDeletedObjects().size();
System.out.println(successfulDeletes + " objects successfully deleted.");
} catch (AmazonServiceException e) {
// The call was transmitted successfully, but Amazon S3 couldn't process
// it, so it returned an error response.
e.printStackTrace();
} catch (SdkClientException e) {
// Amazon S3 couldn't be contacted for a response, or the client
// couldn't parse the response from Amazon S3.
e.printStackTrace();
}
}
}