Amazon S3 code examples for the SDK for Java 2.x

Overview

Shows how to use the AWS SDK for Java 2.x to work with Amazon Simple Storage Service (Amazon S3).

<!--custom.overview.start--> <!--custom.overview.end-->

Amazon S3 is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web.

⚠ Important

• Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the javav2 folder.

<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Get started

• Hello Amazon S3 (ListBuckets)

Basics

Code examples that show you how to perform the essential operations within a service.

• Learn the basics

Single actions

Code excerpts that show you how to call individual service functions.

• AbortMultipartUpload
• CopyObject
• CreateBucket
• DeleteBucket
• DeleteBucketPolicy
• DeleteBucketWebsite
• DeleteObject
• DeleteObjects
• GetBucketAcl
• GetBucketPolicy
• GetBucketReplication
• GetObject
• GetObjectLegalHold
• GetObjectLockConfiguration
• GetObjectRetention
• HeadObject
• ListBuckets
• ListMultipartUploads
• ListObjectsV2
• PutBucketAcl
• PutBucketCors
• PutBucketLifecycleConfiguration
• PutBucketPolicy
• PutBucketReplication
• PutBucketVersioning
• PutBucketWebsite
• PutObject
• PutObjectLegalHold
• PutObjectLockConfiguration
• PutObjectRetention
• RestoreObject
• SelectObjectContent
• UploadPartCopy

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

• Check if a bucket exists
• Delete incomplete multipart uploads
• Download S3 'directories'
• Download objects to a local directory
• Lock Amazon S3 objects
• Manage large messages using S3
• Parse URIs
• Process S3 event notifications
• Send event notifications to EventBridge
• Track uploads and downloads
• Upload directory to a bucket
• Upload or download large files
• Upload stream of unknown size
• Use checksums

<!--custom.examples.start-->

• Create a presigned URL for download
• Create a presigned URL with metadata in headers for upload
• Create a presigned URL with query parameters for upload

<!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Hello Amazon S3

This example shows you how to get started using Amazon S3.

Learn the basics

This example shows you how to do the following:

• Create a bucket and upload a file to it.
• Download an object from a bucket.
• Copy an object to a subfolder in a bucket.
• List the objects in a bucket.
• Delete the bucket objects and the bucket.

<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start--> <!--custom.basic_prereqs.s3_Scenario_GettingStarted.end--> <!--custom.basics.s3_Scenario_GettingStarted.start--> <!--custom.basics.s3_Scenario_GettingStarted.end-->

Check if a bucket exists

This example shows you how to check if a bucket exists.

<!--custom.scenario_prereqs.s3_Scenario_DoesBucketExist.start--> <!--custom.scenario_prereqs.s3_Scenario_DoesBucketExist.end--> <!--custom.scenarios.s3_Scenario_DoesBucketExist.start--> <!--custom.scenarios.s3_Scenario_DoesBucketExist.end-->

Delete incomplete multipart uploads

This example shows you how to how to delete or stop incomplete Amazon S3 multipart uploads.

<!--custom.scenario_prereqs.s3_Scenario_AbortMultipartUpload.start--> <!--custom.scenario_prereqs.s3_Scenario_AbortMultipartUpload.end--> <!--custom.scenarios.s3_Scenario_AbortMultipartUpload.start--> <!--custom.scenarios.s3_Scenario_AbortMultipartUpload.end-->

Download S3 'directories'

This example shows you how to download and filter the contents of Amazon S3 bucket 'directories'.

<!--custom.scenario_prereqs.s3_Scenario_DownloadS3Directory.start--> <!--custom.scenario_prereqs.s3_Scenario_DownloadS3Directory.end--> <!--custom.scenarios.s3_Scenario_DownloadS3Directory.start--> <!--custom.scenarios.s3_Scenario_DownloadS3Directory.end-->

Download objects to a local directory

This example shows you how to download all objects in an Amazon Simple Storage Service (Amazon S3) bucket to a local directory.

<!--custom.scenario_prereqs.s3_DownloadBucketToDirectory.start--> <!--custom.scenario_prereqs.s3_DownloadBucketToDirectory.end--> <!--custom.scenarios.s3_DownloadBucketToDirectory.start--> <!--custom.scenarios.s3_DownloadBucketToDirectory.end-->

Lock Amazon S3 objects

This example shows you how to work with S3 object lock features.

<!--custom.scenario_prereqs.s3_Scenario_ObjectLock.start--> <!--custom.scenario_prereqs.s3_Scenario_ObjectLock.end--> <!--custom.scenarios.s3_Scenario_ObjectLock.start--> <!--custom.scenarios.s3_Scenario_ObjectLock.end-->

Manage large messages using S3

This example shows you how to use the Amazon SQS Extended Client Library to work with large Amazon SQS messages.

<!--custom.scenario_prereqs.sqs_Scenario_SqsExtendedClient.start--> <!--custom.scenario_prereqs.sqs_Scenario_SqsExtendedClient.end--> <!--custom.scenarios.sqs_Scenario_SqsExtendedClient.start--> <!--custom.scenarios.sqs_Scenario_SqsExtendedClient.end-->

Parse URIs

This example shows you how to parse Amazon S3 URIs to extract important components like the bucket name and object key.

<!--custom.scenario_prereqs.s3_Scenario_URIParsing.start--> <!--custom.scenario_prereqs.s3_Scenario_URIParsing.end--> <!--custom.scenarios.s3_Scenario_URIParsing.start--> <!--custom.scenarios.s3_Scenario_URIParsing.end-->

Process S3 event notifications

This example shows you how to work with S3 event notifications in an object-oriented way.

<!--custom.scenario_prereqs.s3_Scenario_ProcessS3EventNotification.start--> <!--custom.scenario_prereqs.s3_Scenario_ProcessS3EventNotification.end--> <!--custom.scenarios.s3_Scenario_ProcessS3EventNotification.start--> <!--custom.scenarios.s3_Scenario_ProcessS3EventNotification.end-->

Send event notifications to EventBridge

This example shows you how to enable a bucket to send S3 event notifications to EventBridge and route notifications to an Amazon SNS topic and Amazon SQS queue.

<!--custom.scenario_prereqs.s3_Scenario_PutBucketNotificationConfiguration.start--> <!--custom.scenario_prereqs.s3_Scenario_PutBucketNotificationConfiguration.end--> <!--custom.scenarios.s3_Scenario_PutBucketNotificationConfiguration.start--> <!--custom.scenarios.s3_Scenario_PutBucketNotificationConfiguration.end-->

Track uploads and downloads

This example shows you how to track an Amazon S3 object upload or download.

<!--custom.scenario_prereqs.s3_Scenario_TrackUploadDownload.start--> <!--custom.scenario_prereqs.s3_Scenario_TrackUploadDownload.end--> <!--custom.scenarios.s3_Scenario_TrackUploadDownload.start--> <!--custom.scenarios.s3_Scenario_TrackUploadDownload.end-->

Upload directory to a bucket

This example shows you how to upload a local directory recursively to an Amazon Simple Storage Service (Amazon S3) bucket.

<!--custom.scenario_prereqs.s3_UploadDirectoryToBucket.start--> <!--custom.scenario_prereqs.s3_UploadDirectoryToBucket.end--> <!--custom.scenarios.s3_UploadDirectoryToBucket.start--> <!--custom.scenarios.s3_UploadDirectoryToBucket.end-->

Upload or download large files

This example shows you how to upload or download large files to and from Amazon S3.

<!--custom.scenario_prereqs.s3_Scenario_UsingLargeFiles.start--> <!--custom.scenario_prereqs.s3_Scenario_UsingLargeFiles.end--> <!--custom.scenarios.s3_Scenario_UsingLargeFiles.start--> <!--custom.scenarios.s3_Scenario_UsingLargeFiles.end-->

Upload stream of unknown size

This example shows you how to upload a stream of unknown size to an Amazon S3 object.

<!--custom.scenario_prereqs.s3_Scenario_UploadStream.start--> <!--custom.scenario_prereqs.s3_Scenario_UploadStream.end--> <!--custom.scenarios.s3_Scenario_UploadStream.start--> <!--custom.scenarios.s3_Scenario_UploadStream.end-->

Use checksums

This example shows you how to use checksums to work with an Amazon S3 object.

<!--custom.scenario_prereqs.s3_Scenario_UseChecksums.start--> <!--custom.scenario_prereqs.s3_Scenario_UseChecksums.end--> <!--custom.scenarios.s3_Scenario_UseChecksums.start--> <!--custom.scenarios.s3_Scenario_UseChecksums.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javav2 folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

• Amazon S3 User Guide
• Amazon S3 API Reference
• SDK for Java 2.x Amazon S3 reference

<!--custom.resources.start--> <!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0