Package software.amazon.awssdk.services.s3

package software.amazon.awssdk.services.s3

For information about using the Amazon S3 API—including authentication, signing requests, code examples, and error handling—see the Amazon S3 Developer Guide.

Welcome to the Amazon S3 API Reference. This guide explains the Amazon Simple Storage Service (Amazon S3) application programming interface (API).

Welcome to the Amazon S3 API Reference. This guide explains the Amazon Simple Storage Service (Amazon S3) application programming interface (API).

You can use any toolkit that supports HTTP to use the REST API. You can even use a browser to fetch objects, as long as they are anonymously readable.

The REST API uses the standard HTTP headers and status codes, so that standard browsers and toolkits work as expected. In some areas, we have added functionality to HTTP (for example, we added headers to support access control). In these cases, we have done our best to add the new functionality in a way that matched the style of standard HTTP usage.

The current version of the Amazon S3 API is 2006-03-01.

Amazon S3 supports the REST API.

Support for SOAP over HTTP is deprecated, but it is still available over HTTPS. However, new Amazon S3 features will not be supported for SOAP. We recommend that you use either this REST API or the Amazon Web Services SDKs.

Code Examples

For code examples demonstrating how to use this service with the AWS SDK for Java v2, see:

Getting Started

• Hello Amazon S3

Basics

• Learn the basics of Amazon S3 with an AWS SDK

API Actions

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

Scenarios

• Manage large Amazon SQS messages using Amazon S3 with an AWS SDK
• Send S3 event notifications to Amazon EventBridge using an AWS SDK
• Download all objects in an Amazon Simple Storage Service (Amazon S3) bucket to a local directory
• Recursively upload a local directory to an Amazon Simple Storage Service (Amazon S3) bucket
• Upload or download large files to and from Amazon S3 using an AWS SDK
• Create a presigned URL for Amazon S3 using an AWS SDK
• Parse Amazon S3 URIs using an AWS SDK
• Upload a stream of unknown size to an Amazon S3 object using an AWS SDK
• Use checksums to work with an Amazon S3 object using an AWS SDK
• Work with Amazon S3 object lock features using an AWS SDK
• Track an Amazon S3 object upload or download using an AWS SDK
• Delete incomplete multipart uploads to Amazon S3 using an AWS SDK
• Receive and process Amazon S3 event notifications by using an AWS SDK
• Download S3 'directories' from an Amazon Simple Storage Service (Amazon S3) bucket
• Check if a bucket exists
• Create a photo asset management application that lets users manage photos using labels
• Detect PPE in images with Amazon Rekognition using an AWS SDK
• Detect objects in images with Amazon Rekognition using an AWS SDK
• Detect people and objects in a video with Amazon Rekognition using an AWS SDK

Serverless Examples

• Invoke a Lambda function from an Amazon S3 trigger

Related Packages

Package	Description
software.amazon.awssdk.services.s3.crt
software.amazon.awssdk.services.s3.endpoints
software.amazon.awssdk.services.s3.internal
software.amazon.awssdk.services.s3.model
software.amazon.awssdk.services.s3.multipart
software.amazon.awssdk.services.s3.paginators
software.amazon.awssdk.services.s3.presignedurl
software.amazon.awssdk.services.s3.presigner
software.amazon.awssdk.services.s3.s3express
software.amazon.awssdk.services.s3.transform
software.amazon.awssdk.services.s3.waiters

Class	Description
DelegatingS3AsyncClient
DelegatingS3Client
LegacyMd5Plugin	Plugin that enables legacy MD5 checksum behavior for S3 operations.
S3AsyncClient	Service client for accessing Amazon S3 asynchronously.
S3AsyncClientBuilder	A builder for creating an instance of S3AsyncClient.
S3BaseClientBuilder<B extends S3BaseClientBuilder<B,C>,C>	This includes configuration specific to Amazon S3 that is supported by both S3ClientBuilder and S3AsyncClientBuilder.
S3Client	Service client for accessing Amazon S3.
S3ClientBuilder	A builder for creating an instance of S3Client.
S3Configuration
S3Configuration.Builder
S3CrtAsyncClientBuilder	Builder API to build instance of Common Run Time based S3AsyncClient.
S3ServiceClientConfiguration	Class to expose the service client settings to the user.
S3ServiceClientConfiguration.Builder	A builder for creating a S3ServiceClientConfiguration
S3SystemSetting	S3 specific system setting
S3Uri	Object that represents a parsed S3 URI.
S3Uri.Builder	A builder for creating a S3Uri
S3Utilities	Utilities for working with Amazon S3 objects.
S3Utilities.Builder	Builder class to construct S3Utilities object