@Generated(value="software.amazon.awssdk:codegen") public interface S3Client extends AutoCloseable
builder()
method.
nullModifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AbortMultipartUploadResponse |
abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
Aborts a multipart upload.
|
static S3ClientBuilder |
builder()
Create a builder that can be used to configure and create a
S3Client . |
default CompleteMultipartUploadResponse |
completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
|
default CopyObjectResponse |
copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
static S3Client |
create()
Create a
S3Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateBucketResponse |
createBucket(CreateBucketRequest createBucketRequest)
Creates a new bucket.
|
default CreateMultipartUploadResponse |
createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest)
Initiates a multipart upload and returns an upload ID.
|
default DeleteBucketResponse |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the bucket.
|
default DeleteBucketAnalyticsConfigurationResponse |
deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default DeleteBucketCorsResponse |
deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
Deletes the cors configuration information set for the bucket.
|
default DeleteBucketInventoryConfigurationResponse |
deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
|
default DeleteBucketLifecycleResponse |
deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the bucket.
|
default DeleteBucketMetricsConfigurationResponse |
deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default DeleteBucketPolicyResponse |
deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
Deletes the policy from the bucket.
|
default DeleteBucketReplicationResponse |
deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
|
default DeleteBucketTaggingResponse |
deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
Deletes the tags from the bucket.
|
default DeleteBucketWebsiteResponse |
deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
This operation removes the website configuration from the bucket.
|
default DeleteObjectResponse |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
version of the object.
|
default DeleteObjectsResponse |
deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
|
default DeleteObjectTaggingResponse |
deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
|
default GetBucketAccelerateConfigurationResponse |
getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
Returns the accelerate configuration of a bucket.
|
default GetBucketAclResponse |
getBucketAcl(GetBucketAclRequest getBucketAclRequest)
Gets the access control policy for the bucket.
|
default GetBucketAnalyticsConfigurationResponse |
getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default GetBucketCorsResponse |
getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
Returns the cors configuration for the bucket.
|
default GetBucketInventoryConfigurationResponse |
getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
|
default GetBucketLifecycleResponse |
getBucketLifecycle(GetBucketLifecycleRequest getBucketLifecycleRequest)
Deprecated, see the GetBucketLifecycleConfiguration operation.
|
default GetBucketLifecycleConfigurationResponse |
getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
Returns the lifecycle configuration information set on the bucket.
|
default GetBucketLocationResponse |
getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
Returns the region the bucket resides in.
|
default GetBucketLoggingResponse |
getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status.
|
default GetBucketMetricsConfigurationResponse |
getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default GetBucketNotificationResponse |
getBucketNotification(GetBucketNotificationRequest getBucketNotificationRequest)
Deprecated, see the GetBucketNotificationConfiguration operation.
|
default GetBucketNotificationConfigurationResponse |
getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
|
default GetBucketPolicyResponse |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default GetBucketReplicationResponse |
getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
Returns the replication configuration of a bucket.
|
default GetBucketRequestPaymentResponse |
getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
|
default GetBucketTaggingResponse |
getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
Returns the tag set associated with the bucket.
|
default GetBucketVersioningResponse |
getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
Returns the versioning state of a bucket.
|
default GetBucketWebsiteResponse |
getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default <ReturnT> ReturnT |
getObject(GetObjectRequest getObjectRequest,
StreamingResponseHandler streamingHandler)
Retrieves objects from Amazon S3.
|
default GetObjectAclResponse |
getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
default GetObjectTaggingResponse |
getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object.
|
default <ReturnT> ReturnT |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
StreamingResponseHandler streamingHandler)
Return torrent files from a bucket.
|
default HeadBucketResponse |
headBucket(HeadBucketRequest headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
|
default HeadObjectResponse |
headObject(HeadObjectRequest headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself.
|
default ListBucketAnalyticsConfigurationsResponse |
listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
|
default ListBucketInventoryConfigurationsResponse |
listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
|
default ListBucketMetricsConfigurationsResponse |
listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
|
default ListBucketsResponse |
listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
default ListMultipartUploadsResponse |
listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default ListObjectsResponse |
listObjects(ListObjectsRequest listObjectsRequest)
Returns some or all (up to 1000) of the objects in a bucket.
|
default ListObjectsV2Response |
listObjectsV2(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket.
|
default ListObjectVersionsResponse |
listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
|
default ListPartsResponse |
listParts(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default PutBucketAccelerateConfigurationResponse |
putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
|
default PutBucketAclResponse |
putBucketAcl(PutBucketAclRequest putBucketAclRequest)
Sets the permissions on a bucket using access control lists (ACL).
|
default PutBucketAnalyticsConfigurationResponse |
putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default PutBucketCorsResponse |
putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the cors configuration for a bucket.
|
default PutBucketInventoryConfigurationResponse |
putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
|
default PutBucketLifecycleResponse |
putBucketLifecycle(PutBucketLifecycleRequest putBucketLifecycleRequest)
Deprecated, see the PutBucketLifecycleConfiguration operation.
|
default PutBucketLifecycleConfigurationResponse |
putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
Sets lifecycle configuration for your bucket.
|
default PutBucketLoggingResponse |
putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
parameters.
|
default PutBucketMetricsConfigurationResponse |
putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default PutBucketNotificationResponse |
putBucketNotification(PutBucketNotificationRequest putBucketNotificationRequest)
Deprecated, see the PutBucketNotificationConfiguraiton operation.
|
default PutBucketNotificationConfigurationResponse |
putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default PutBucketPolicyResponse |
putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Replaces a policy on a bucket.
|
default PutBucketReplicationResponse |
putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a new replication configuration (or replaces an existing one, if present).
|
default PutBucketRequestPaymentResponse |
putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket.
|
default PutBucketTaggingResponse |
putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
Sets the tags for a bucket.
|
default PutBucketVersioningResponse |
putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
Sets the versioning state of an existing bucket.
|
default PutBucketWebsiteResponse |
putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
Set the website configuration for a bucket.
|
default PutObjectResponse |
putObject(PutObjectRequest putObjectRequest,
RequestBody requestBody)
Adds an object to a bucket.
|
default PutObjectAclResponse |
putObjectAcl(PutObjectAclRequest putObjectAclRequest)
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a
bucket
|
default PutObjectTaggingResponse |
putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
|
default RestoreObjectResponse |
restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
static ServiceMetadata |
serviceMetadata() |
default UploadPartResponse |
uploadPart(UploadPartRequest uploadPartRequest,
RequestBody requestBody)
Uploads a part in a multipart upload.
|
default UploadPartCopyResponse |
uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
close
static final String SERVICE_NAME
static S3Client create()
S3Client
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static S3ClientBuilder builder()
S3Client
.default AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest) throws NoSuchUploadException, SdkBaseException, SdkClientException, S3Exception
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
abortMultipartUploadRequest
- NoSuchUploadException
- The specified multipart upload does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CompleteMultipartUploadResponse completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest) throws SdkBaseException, SdkClientException, S3Exception
completeMultipartUploadRequest
- SdkBaseException
SdkClientException
S3Exception
default CopyObjectResponse copyObject(CopyObjectRequest copyObjectRequest) throws ObjectNotInActiveTierErrorException, SdkBaseException, SdkClientException, S3Exception
copyObjectRequest
- ObjectNotInActiveTierErrorException
- The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) throws BucketAlreadyExistsException, BucketAlreadyOwnedByYouException, SdkBaseException, SdkClientException, S3Exception
createBucketRequest
- BucketAlreadyExistsException
- The requested bucket name is not available. The bucket namespace is shared by all users of the system.
Please select a different name and try again.BucketAlreadyOwnedByYouException
SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest) throws SdkBaseException, SdkClientException, S3Exception
Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
createMultipartUploadRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketAnalyticsConfigurationResponse deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketAnalyticsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketCorsResponse deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketCorsRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketInventoryConfigurationResponse deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketInventoryConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketLifecycleResponse deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketLifecycleRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketMetricsConfigurationResponse deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketMetricsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketPolicyResponse deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketPolicyRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketReplicationResponse deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketReplicationRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketTaggingResponse deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteBucketWebsiteResponse deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteBucketWebsiteRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteObjectRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteObjectTaggingResponse deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteObjectTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default DeleteObjectsResponse deleteObjects(DeleteObjectsRequest deleteObjectsRequest) throws SdkBaseException, SdkClientException, S3Exception
deleteObjectsRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketAccelerateConfigurationResponse getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketAccelerateConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketAclResponse getBucketAcl(GetBucketAclRequest getBucketAclRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketAclRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketAnalyticsConfigurationResponse getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketAnalyticsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketCorsResponse getBucketCors(GetBucketCorsRequest getBucketCorsRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketCorsRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketInventoryConfigurationResponse getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketInventoryConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketLifecycleResponse getBucketLifecycle(GetBucketLifecycleRequest getBucketLifecycleRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketLifecycleRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketLifecycleConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketLocationResponse getBucketLocation(GetBucketLocationRequest getBucketLocationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketLocationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketLoggingResponse getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketLoggingRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketMetricsConfigurationResponse getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketMetricsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketNotificationResponse getBucketNotification(GetBucketNotificationRequest getBucketNotificationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketNotificationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketNotificationConfigurationResponse getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketNotificationConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketPolicyResponse getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketPolicyRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketReplicationResponse getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketReplicationRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketRequestPaymentResponse getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketRequestPaymentRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketTaggingResponse getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketVersioningResponse getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketVersioningRequest
- SdkBaseException
SdkClientException
S3Exception
default GetBucketWebsiteResponse getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest) throws SdkBaseException, SdkClientException, S3Exception
getBucketWebsiteRequest
- SdkBaseException
SdkClientException
S3Exception
default <ReturnT> ReturnT getObject(GetObjectRequest getObjectRequest, StreamingResponseHandler streamingHandler) throws NoSuchKeyException, SdkBaseException, SdkClientException, S3Exception
getObjectRequest
- streamingHandler
- Functional interface for processing the streamed response content. The unmarshalled GetObjectResponse and
an InputStream to the response content are provided as parameters to the callback. The callback may return
a transformed type which will be the return value of this method. See
StreamingResponseHandler
for details on implementing this
interface and for links to precanned implementations for common scenarios like downloading to a file. The
service documentation for the response content is as follows 'Object data.'.NoSuchKeyException
- The specified key does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetObjectAclResponse getObjectAcl(GetObjectAclRequest getObjectAclRequest) throws NoSuchKeyException, SdkBaseException, SdkClientException, S3Exception
getObjectAclRequest
- NoSuchKeyException
- The specified key does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetObjectTaggingResponse getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
getObjectTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default <ReturnT> ReturnT getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, StreamingResponseHandler streamingHandler) throws SdkBaseException, SdkClientException, S3Exception
getObjectTorrentRequest
- streamingHandler
- Functional interface for processing the streamed response content. The unmarshalled
GetObjectTorrentResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
StreamingResponseHandler
for details on implementing this
interface and for links to precanned implementations for common scenarios like downloading to a file. The
service documentation for the response content is as follows ''.SdkBaseException
SdkClientException
S3Exception
default HeadBucketResponse headBucket(HeadBucketRequest headBucketRequest) throws NoSuchBucketException, SdkBaseException, SdkClientException, S3Exception
headBucketRequest
- NoSuchBucketException
- The specified bucket does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault HeadObjectResponse headObject(HeadObjectRequest headObjectRequest) throws NoSuchKeyException, SdkBaseException, SdkClientException, S3Exception
headObjectRequest
- NoSuchKeyException
- The specified key does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListBucketAnalyticsConfigurationsResponse listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest) throws SdkBaseException, SdkClientException, S3Exception
listBucketAnalyticsConfigurationsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListBucketInventoryConfigurationsResponse listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest) throws SdkBaseException, SdkClientException, S3Exception
listBucketInventoryConfigurationsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListBucketMetricsConfigurationsResponse listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest) throws SdkBaseException, SdkClientException, S3Exception
listBucketMetricsConfigurationsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListBucketsResponse listBuckets(ListBucketsRequest listBucketsRequest) throws SdkBaseException, SdkClientException, S3Exception
listBucketsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListMultipartUploadsResponse listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest) throws SdkBaseException, SdkClientException, S3Exception
listMultipartUploadsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListObjectVersionsResponse listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest) throws SdkBaseException, SdkClientException, S3Exception
listObjectVersionsRequest
- SdkBaseException
SdkClientException
S3Exception
default ListObjectsResponse listObjects(ListObjectsRequest listObjectsRequest) throws NoSuchBucketException, SdkBaseException, SdkClientException, S3Exception
listObjectsRequest
- NoSuchBucketException
- The specified bucket does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListObjectsV2Response listObjectsV2(ListObjectsV2Request listObjectsV2Request) throws NoSuchBucketException, SdkBaseException, SdkClientException, S3Exception
listObjectsV2Request
- NoSuchBucketException
- The specified bucket does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPartsResponse listParts(ListPartsRequest listPartsRequest) throws SdkBaseException, SdkClientException, S3Exception
listPartsRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketAccelerateConfigurationResponse putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketAccelerateConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketAclResponse putBucketAcl(PutBucketAclRequest putBucketAclRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketAclRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketAnalyticsConfigurationResponse putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketAnalyticsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketCorsResponse putBucketCors(PutBucketCorsRequest putBucketCorsRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketCorsRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketInventoryConfigurationResponse putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketInventoryConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketLifecycleResponse putBucketLifecycle(PutBucketLifecycleRequest putBucketLifecycleRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketLifecycleRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketLifecycleConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketLoggingResponse putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketLoggingRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketMetricsConfigurationResponse putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketMetricsConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketNotificationResponse putBucketNotification(PutBucketNotificationRequest putBucketNotificationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketNotificationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketNotificationConfigurationResponse putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketNotificationConfigurationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketPolicyResponse putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketPolicyRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketReplicationResponse putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketReplicationRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketRequestPaymentResponse putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketRequestPaymentRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketTaggingResponse putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketVersioningResponse putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketVersioningRequest
- SdkBaseException
SdkClientException
S3Exception
default PutBucketWebsiteResponse putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest) throws SdkBaseException, SdkClientException, S3Exception
putBucketWebsiteRequest
- SdkBaseException
SdkClientException
S3Exception
default PutObjectResponse putObject(PutObjectRequest putObjectRequest, RequestBody requestBody) throws SdkBaseException, SdkClientException, S3Exception
putObjectRequest
- requestBody
- The content to send to the service. A RequestBody
can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.of(new File("myfile.txt"))
See documentation in RequestBody
for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Object data.'.SdkBaseException
SdkClientException
S3Exception
default PutObjectAclResponse putObjectAcl(PutObjectAclRequest putObjectAclRequest) throws NoSuchKeyException, SdkBaseException, SdkClientException, S3Exception
putObjectAclRequest
- NoSuchKeyException
- The specified key does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutObjectTaggingResponse putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest) throws SdkBaseException, SdkClientException, S3Exception
putObjectTaggingRequest
- SdkBaseException
SdkClientException
S3Exception
default RestoreObjectResponse restoreObject(RestoreObjectRequest restoreObjectRequest) throws ObjectAlreadyInActiveTierErrorException, SdkBaseException, SdkClientException, S3Exception
restoreObjectRequest
- ObjectAlreadyInActiveTierErrorException
- This operation is not allowed against this storage tierSdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)S3Exception
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UploadPartResponse uploadPart(UploadPartRequest uploadPartRequest, RequestBody requestBody) throws SdkBaseException, SdkClientException, S3Exception
Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
uploadPartRequest
- requestBody
- The content to send to the service. A RequestBody
can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.of(new File("myfile.txt"))
See documentation in RequestBody
for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Object data.'.SdkBaseException
SdkClientException
S3Exception
default UploadPartCopyResponse uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest) throws SdkBaseException, SdkClientException, S3Exception
uploadPartCopyRequest
- SdkBaseException
SdkClientException
S3Exception
static ServiceMetadata serviceMetadata()
Copyright © 2017. All rights reserved.