Getting an S3 on Outposts bucket by using the Amazon CLI and the SDK for Java - Amazon Simple Storage Service
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).

Getting an S3 on Outposts bucket by using the Amazon CLI and the SDK for Java

With Amazon S3 on Outposts, you can create S3 buckets on your Amazon Outposts and easily store and retrieve objects on premises for applications that require local data access, local data processing, and data residency. S3 on Outposts provides a new storage class, S3 Outposts (OUTPOSTS), which uses the Amazon S3 APIs, and is designed to store data durably and redundantly across multiple devices and servers on your Amazon Outposts. You communicate with your Outpost bucket by using an access point and endpoint connection over a virtual private cloud (VPC). You can use the same APIs and features on Outpost buckets as you do on Amazon S3 buckets, including access policies, encryption, and tagging. You can use S3 on Outposts through the Amazon Web Services Management Console, Amazon Command Line Interface (Amazon CLI), Amazon SDKs, or REST API. For more information, see What is Amazon S3 on Outposts?

The following examples show you how to get an S3 on Outposts bucket by using the Amazon CLI and Amazon SDK for Java.

Note

When you're working with Amazon S3 on Outposts through the Amazon CLI or Amazon SDKs, you provide the access point ARN for the Outpost in place of the bucket name. The access point ARN takes the following form, where region is the Amazon Web Services Region code for the Region that the Outpost is homed to:

arn:aws-cn:s3-outposts:region:123456789012:outpost/op-01ac5d28a6a232904/accesspoint/example-outposts-access-point

For more information about S3 on Outposts ARNs, see Resource ARNs for S3 on Outposts.

The following S3 on Outposts example gets a bucket by using the Amazon CLI. To use this command, replace each user input placeholder with your own information. For more information about this command, see get-bucket in the Amazon CLI Reference.

aws s3control get-bucket --account-id 123456789012 --bucket "arn:aws-cn:s3-outposts:region:123456789012:outpost/op-01ac5d28a6a232904/bucket/example-outposts-bucket"

The following S3 on Outposts example gets a bucket by using the SDK for Java. For more information, see GetBucket in the Amazon Simple Storage Service API Reference.

import com.amazonaws.services.s3control.model.*;

public void getBucket(String bucketArn) {

    GetBucketRequest reqGetBucket = new GetBucketRequest()
            .withBucket(bucketArn)
            .withAccountId(AccountId);

    GetBucketResult respGetBucket = s3ControlClient.getBucket(reqGetBucket);
    System.out.printf("GetBucket Response: %s%n", respGetBucket.toString());

}