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).
Use HeadBucket
with an Amazon SDK
The following code example shows how to use HeadBucket
.
- Java
-
- SDK for Java 2.x
-
Checks if the specified S3 directory bucket exists and is accessible.
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import static com.example.s3.util.S3DirectoryBucketUtils.createDirectoryBucket;
import static com.example.s3.util.S3DirectoryBucketUtils.createS3Client;
import static com.example.s3.util.S3DirectoryBucketUtils.deleteDirectoryBucket;
/**
* Checks if the specified S3 directory bucket exists and is accessible.
*
* @param s3Client The S3 client used to interact with S3
* @param bucketName The name of the directory bucket to check
* @return True if the bucket exists and is accessible, false otherwise
*/
public static boolean headDirectoryBucket(S3Client s3Client, String bucketName) {
logger.info("Checking if bucket exists: {}", bucketName);
try {
// Create a HeadBucketRequest
HeadBucketRequest headBucketRequest = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
// If the bucket doesn't exist, the following statement throws NoSuchBucketException,
// which is a subclass of S3Exception.
s3Client.headBucket(headBucketRequest);
logger.info("Amazon S3 directory bucket: \"{}\" found.", bucketName);
return true;
} catch (S3Exception e) {
logger.error("Failed to access bucket: {} - Error code: {}", e.awsErrorDetails().errorMessage(),
e.awsErrorDetails().errorCode(), e);
throw e;
}
}
For a complete list of Amazon SDK developer guides and code examples, see
Developing with Amazon S3 using the Amazon SDKs.
This topic also includes information about getting started and details about previous SDK versions.