software.amazon.awssdk.services.s3.S3AsyncClient Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3;
import java.nio.file.Path;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.core.async.AsyncRequestBody;
import software.amazon.awssdk.core.async.AsyncResponseTransformer;
import software.amazon.awssdk.services.s3.internal.crt.S3CrtAsyncClient;
import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.AbortMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
import software.amazon.awssdk.services.s3.model.CopyObjectResponse;
import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
import software.amazon.awssdk.services.s3.model.CreateBucketResponse;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketAnalyticsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketAnalyticsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketCorsRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketCorsResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketEncryptionRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketEncryptionResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketIntelligentTieringConfigurationRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketIntelligentTieringConfigurationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketInventoryConfigurationRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketInventoryConfigurationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketLifecycleRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketLifecycleResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketMetricsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketMetricsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketOwnershipControlsRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketOwnershipControlsResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketPolicyRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketPolicyResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketReplicationRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketReplicationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketTaggingRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketTaggingResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketWebsiteRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketWebsiteResponse;
import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectResponse;
import software.amazon.awssdk.services.s3.model.DeleteObjectTaggingRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectTaggingResponse;
import software.amazon.awssdk.services.s3.model.DeleteObjectsRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectsResponse;
import software.amazon.awssdk.services.s3.model.DeletePublicAccessBlockRequest;
import software.amazon.awssdk.services.s3.model.DeletePublicAccessBlockResponse;
import software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketAccelerateConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketAclRequest;
import software.amazon.awssdk.services.s3.model.GetBucketAclResponse;
import software.amazon.awssdk.services.s3.model.GetBucketAnalyticsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketAnalyticsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketCorsRequest;
import software.amazon.awssdk.services.s3.model.GetBucketCorsResponse;
import software.amazon.awssdk.services.s3.model.GetBucketEncryptionRequest;
import software.amazon.awssdk.services.s3.model.GetBucketEncryptionResponse;
import software.amazon.awssdk.services.s3.model.GetBucketIntelligentTieringConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketIntelligentTieringConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketInventoryConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketInventoryConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketLocationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketLocationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketLoggingRequest;
import software.amazon.awssdk.services.s3.model.GetBucketLoggingResponse;
import software.amazon.awssdk.services.s3.model.GetBucketMetricsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketMetricsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketNotificationConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketOwnershipControlsRequest;
import software.amazon.awssdk.services.s3.model.GetBucketOwnershipControlsResponse;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyRequest;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyStatusRequest;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyStatusResponse;
import software.amazon.awssdk.services.s3.model.GetBucketReplicationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketReplicationResponse;
import software.amazon.awssdk.services.s3.model.GetBucketRequestPaymentRequest;
import software.amazon.awssdk.services.s3.model.GetBucketRequestPaymentResponse;
import software.amazon.awssdk.services.s3.model.GetBucketTaggingRequest;
import software.amazon.awssdk.services.s3.model.GetBucketTaggingResponse;
import software.amazon.awssdk.services.s3.model.GetBucketVersioningRequest;
import software.amazon.awssdk.services.s3.model.GetBucketVersioningResponse;
import software.amazon.awssdk.services.s3.model.GetBucketWebsiteRequest;
import software.amazon.awssdk.services.s3.model.GetBucketWebsiteResponse;
import software.amazon.awssdk.services.s3.model.GetObjectAclRequest;
import software.amazon.awssdk.services.s3.model.GetObjectAclResponse;
import software.amazon.awssdk.services.s3.model.GetObjectAttributesRequest;
import software.amazon.awssdk.services.s3.model.GetObjectAttributesResponse;
import software.amazon.awssdk.services.s3.model.GetObjectLegalHoldRequest;
import software.amazon.awssdk.services.s3.model.GetObjectLegalHoldResponse;
import software.amazon.awssdk.services.s3.model.GetObjectLockConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetObjectLockConfigurationResponse;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.awssdk.services.s3.model.GetObjectRetentionRequest;
import software.amazon.awssdk.services.s3.model.GetObjectRetentionResponse;
import software.amazon.awssdk.services.s3.model.GetObjectTaggingRequest;
import software.amazon.awssdk.services.s3.model.GetObjectTaggingResponse;
import software.amazon.awssdk.services.s3.model.GetObjectTorrentRequest;
import software.amazon.awssdk.services.s3.model.GetObjectTorrentResponse;
import software.amazon.awssdk.services.s3.model.GetPublicAccessBlockRequest;
import software.amazon.awssdk.services.s3.model.GetPublicAccessBlockResponse;
import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
import software.amazon.awssdk.services.s3.model.HeadBucketResponse;
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
import software.amazon.awssdk.services.s3.model.ListBucketAnalyticsConfigurationsRequest;
import software.amazon.awssdk.services.s3.model.ListBucketAnalyticsConfigurationsResponse;
import software.amazon.awssdk.services.s3.model.ListBucketIntelligentTieringConfigurationsRequest;
import software.amazon.awssdk.services.s3.model.ListBucketIntelligentTieringConfigurationsResponse;
import software.amazon.awssdk.services.s3.model.ListBucketInventoryConfigurationsRequest;
import software.amazon.awssdk.services.s3.model.ListBucketInventoryConfigurationsResponse;
import software.amazon.awssdk.services.s3.model.ListBucketMetricsConfigurationsRequest;
import software.amazon.awssdk.services.s3.model.ListBucketMetricsConfigurationsResponse;
import software.amazon.awssdk.services.s3.model.ListBucketsRequest;
import software.amazon.awssdk.services.s3.model.ListBucketsResponse;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse;
import software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest;
import software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse;
import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
import software.amazon.awssdk.services.s3.model.ListObjectsResponse;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Response;
import software.amazon.awssdk.services.s3.model.ListPartsRequest;
import software.amazon.awssdk.services.s3.model.ListPartsResponse;
import software.amazon.awssdk.services.s3.model.PutBucketAccelerateConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketAccelerateConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketAclRequest;
import software.amazon.awssdk.services.s3.model.PutBucketAclResponse;
import software.amazon.awssdk.services.s3.model.PutBucketAnalyticsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketAnalyticsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketCorsRequest;
import software.amazon.awssdk.services.s3.model.PutBucketCorsResponse;
import software.amazon.awssdk.services.s3.model.PutBucketEncryptionRequest;
import software.amazon.awssdk.services.s3.model.PutBucketEncryptionResponse;
import software.amazon.awssdk.services.s3.model.PutBucketIntelligentTieringConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketIntelligentTieringConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketInventoryConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketInventoryConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketLifecycleConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketLifecycleConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketLoggingRequest;
import software.amazon.awssdk.services.s3.model.PutBucketLoggingResponse;
import software.amazon.awssdk.services.s3.model.PutBucketMetricsConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketMetricsConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketNotificationConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketNotificationConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketOwnershipControlsRequest;
import software.amazon.awssdk.services.s3.model.PutBucketOwnershipControlsResponse;
import software.amazon.awssdk.services.s3.model.PutBucketPolicyRequest;
import software.amazon.awssdk.services.s3.model.PutBucketPolicyResponse;
import software.amazon.awssdk.services.s3.model.PutBucketReplicationRequest;
import software.amazon.awssdk.services.s3.model.PutBucketReplicationResponse;
import software.amazon.awssdk.services.s3.model.PutBucketRequestPaymentRequest;
import software.amazon.awssdk.services.s3.model.PutBucketRequestPaymentResponse;
import software.amazon.awssdk.services.s3.model.PutBucketTaggingRequest;
import software.amazon.awssdk.services.s3.model.PutBucketTaggingResponse;
import software.amazon.awssdk.services.s3.model.PutBucketVersioningRequest;
import software.amazon.awssdk.services.s3.model.PutBucketVersioningResponse;
import software.amazon.awssdk.services.s3.model.PutBucketWebsiteRequest;
import software.amazon.awssdk.services.s3.model.PutBucketWebsiteResponse;
import software.amazon.awssdk.services.s3.model.PutObjectAclRequest;
import software.amazon.awssdk.services.s3.model.PutObjectAclResponse;
import software.amazon.awssdk.services.s3.model.PutObjectLegalHoldRequest;
import software.amazon.awssdk.services.s3.model.PutObjectLegalHoldResponse;
import software.amazon.awssdk.services.s3.model.PutObjectLockConfigurationRequest;
import software.amazon.awssdk.services.s3.model.PutObjectLockConfigurationResponse;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.PutObjectResponse;
import software.amazon.awssdk.services.s3.model.PutObjectRetentionRequest;
import software.amazon.awssdk.services.s3.model.PutObjectRetentionResponse;
import software.amazon.awssdk.services.s3.model.PutObjectTaggingRequest;
import software.amazon.awssdk.services.s3.model.PutObjectTaggingResponse;
import software.amazon.awssdk.services.s3.model.PutPublicAccessBlockRequest;
import software.amazon.awssdk.services.s3.model.PutPublicAccessBlockResponse;
import software.amazon.awssdk.services.s3.model.RestoreObjectRequest;
import software.amazon.awssdk.services.s3.model.RestoreObjectResponse;
import software.amazon.awssdk.services.s3.model.SelectObjectContentRequest;
import software.amazon.awssdk.services.s3.model.SelectObjectContentResponseHandler;
import software.amazon.awssdk.services.s3.model.UploadPartCopyRequest;
import software.amazon.awssdk.services.s3.model.UploadPartCopyResponse;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
import software.amazon.awssdk.services.s3.model.UploadPartResponse;
import software.amazon.awssdk.services.s3.model.WriteGetObjectResponseRequest;
import software.amazon.awssdk.services.s3.model.WriteGetObjectResponseResponse;
import software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher;
import software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher;
import software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher;
import software.amazon.awssdk.services.s3.paginators.ListPartsPublisher;
import software.amazon.awssdk.services.s3.waiters.S3AsyncWaiter;
/**
* Service client for accessing Amazon S3 asynchronously. This can be created using the static {@link #builder()}
* method.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface S3AsyncClient extends AwsClient {
String SERVICE_NAME = "s3";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "s3";
/**
* Creates an instance of {@link S3Utilities} object with the configuration set on this client.
*/
default S3Utilities utilities() {
throw new UnsupportedOperationException();
}
/**
*
* This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded
* using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part
* uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be
* necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by
* all parts.
*
*
* To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that
* the parts list is empty.
*
*
* For information about permissions required to use the multipart upload, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to AbortMultipartUpload:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
* @param abortMultipartUploadRequest
* @return A Java Future containing the result of the AbortMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchUploadException The specified multipart upload does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.AbortMultipartUpload
*/
default CompletableFuture abortMultipartUpload(
AbortMultipartUploadRequest abortMultipartUploadRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded
* using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part
* uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be
* necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by
* all parts.
*
*
* To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that
* the parts list is empty.
*
*
* For information about permissions required to use the multipart upload, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to AbortMultipartUpload:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link AbortMultipartUploadRequest.Builder} avoiding the
* need to create one manually via {@link AbortMultipartUploadRequest#builder()}
*
*
* @param abortMultipartUploadRequest
* A {@link Consumer} that will call methods on {@link AbortMultipartUploadRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AbortMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchUploadException The specified multipart upload does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.AbortMultipartUpload
*/
default CompletableFuture abortMultipartUpload(
Consumer abortMultipartUploadRequest) {
return abortMultipartUpload(AbortMultipartUploadRequest.builder().applyMutation(abortMultipartUploadRequest).build());
}
/**
*
* Completes a multipart upload by assembling previously uploaded parts.
*
*
* You first initiate the multipart upload and then upload all parts using the UploadPart operation. After
* successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon
* receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new
* object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts
* list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you
* must provide the part number and the ETag value, returned after that part was uploaded.
*
*
* Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins
* processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in
* progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request
* could fail after the initial 200 OK response has been sent. This means that a 200 OK response can
* contain either a success or an error. If you call the S3 API directly, make sure to design your application to
* parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle
* this condition. The SDKs detect the embedded error and apply error handling per your configuration settings
* (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an
* exception (or, for the SDKs that don't use exceptions, they return the error).
*
*
* Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed
* requests. For more information, see Amazon S3 Error Best
* Practices.
*
*
*
* You cannot use Content-Type: application/x-www-form-urlencoded with Complete Multipart Upload
* requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload
* returns a 200 OK response.
*
*
*
* For more information about multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information about permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* CompleteMultipartUpload has the following special errors:
*
*
* -
*
* Error code: EntityTooSmall
*
*
* -
*
* Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5
* MB in size, except the last part.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: InvalidPart
*
*
* -
*
* Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the
* specified entity tag might not have matched the part's entity tag.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: InvalidPartOrder
*
*
* -
*
* Description: The list of parts was not in ascending order. The parts list must be specified in order by part
* number.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: NoSuchUpload
*
*
* -
*
* Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart
* upload might have been aborted or completed.
*
*
* -
*
* 404 Not Found
*
*
*
*
*
*
* The following operations are related to CompleteMultipartUpload:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
* @param completeMultipartUploadRequest
* @return A Java Future containing the result of the CompleteMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CompleteMultipartUpload
*/
default CompletableFuture completeMultipartUpload(
CompleteMultipartUploadRequest completeMultipartUploadRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Completes a multipart upload by assembling previously uploaded parts.
*
*
* You first initiate the multipart upload and then upload all parts using the UploadPart operation. After
* successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon
* receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new
* object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts
* list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you
* must provide the part number and the ETag value, returned after that part was uploaded.
*
*
* Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins
* processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in
* progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request
* could fail after the initial 200 OK response has been sent. This means that a 200 OK response can
* contain either a success or an error. If you call the S3 API directly, make sure to design your application to
* parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle
* this condition. The SDKs detect the embedded error and apply error handling per your configuration settings
* (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an
* exception (or, for the SDKs that don't use exceptions, they return the error).
*
*
* Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed
* requests. For more information, see Amazon S3 Error Best
* Practices.
*
*
*
* You cannot use Content-Type: application/x-www-form-urlencoded with Complete Multipart Upload
* requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload
* returns a 200 OK response.
*
*
*
* For more information about multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information about permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* CompleteMultipartUpload has the following special errors:
*
*
* -
*
* Error code: EntityTooSmall
*
*
* -
*
* Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5
* MB in size, except the last part.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: InvalidPart
*
*
* -
*
* Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the
* specified entity tag might not have matched the part's entity tag.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: InvalidPartOrder
*
*
* -
*
* Description: The list of parts was not in ascending order. The parts list must be specified in order by part
* number.
*
*
* -
*
* 400 Bad Request
*
*
*
*
* -
*
* Error code: NoSuchUpload
*
*
* -
*
* Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart
* upload might have been aborted or completed.
*
*
* -
*
* 404 Not Found
*
*
*
*
*
*
* The following operations are related to CompleteMultipartUpload:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CompleteMultipartUploadRequest.Builder} avoiding
* the need to create one manually via {@link CompleteMultipartUploadRequest#builder()}
*
*
* @param completeMultipartUploadRequest
* A {@link Consumer} that will call methods on {@link CompleteMultipartUploadRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CompleteMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CompleteMultipartUpload
*/
default CompletableFuture completeMultipartUpload(
Consumer completeMultipartUploadRequest) {
return completeMultipartUpload(CompleteMultipartUploadRequest.builder().applyMutation(completeMultipartUploadRequest)
.build());
}
/**
*
* Creates a copy of an object that is already stored in Amazon S3.
*
*
*
* You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size
* in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the
* multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the
* REST Multipart Upload API.
*
*
*
* All copy requests must be authenticated. Additionally, you must have read access to the source object and
* write access to the destination bucket. For more information, see REST Authentication. Both the
* Region that you want to copy the object from and the Region that you want to copy the object to must be enabled
* for your account.
*
*
* A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the
* files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error
* occurs during the copy operation, the error response is embedded in the 200 OK response. This means
* that a 200 OK response can contain either a success or an error. If you call the S3 API directly,
* make sure to design your application to parse the contents of the response and handle it appropriately. If you
* use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error
* handling per your configuration settings (including automatically retrying the request as appropriate). If the
* condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the
* error).
*
*
* If the copy is successful, you receive a response with information about the copied object.
*
*
*
* If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the
* content-length, and you would need to read the entire body.
*
*
*
* The copy request charge is based on the storage class and Region that you specify for the destination object. The
* request can also result in a data retrieval charge for the source if the source storage class bills for data
* retrieval. For pricing information, see Amazon S3 pricing.
*
*
*
* Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a
* transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.
*
*
*
* - Metadata
* -
*
* When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access
* control list (ACL) is not preserved and is set to private for the user making the request. To override the
* default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
*
*
* To specify whether you want the object metadata copied from the source object or replaced with metadata provided
* in the request, you can optionally add the x-amz-metadata-directive header. When you grant
* permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata
* behavior when objects are uploaded. For more information, see Specifying Conditions in a
* Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys
* for Amazon S3.
*
*
*
* x-amz-website-redirect-location is unique to each object and must be specified in the request
* headers to copy the value.
*
*
* - x-amz-copy-source-if Headers
* -
*
* To only copy an object under certain conditions, such as whether the Etag matches or whether the
* object was modified before or after a specified date, use the following request parameters:
*
*
* -
*
* x-amz-copy-source-if-match
*
*
* -
*
* x-amz-copy-source-if-none-match
*
*
* -
*
* x-amz-copy-source-if-unmodified-since
*
*
* -
*
* x-amz-copy-source-if-modified-since
*
*
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the
* data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
*
* All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.
*
*
* - Server-side encryption
* -
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you
* don't specify encryption information in your copy request, the encryption setting of the target object is set to
* the default encryption configuration of the destination bucket. By default, all buckets have a base level of
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
* destination bucket has a default encryption configuration that uses server-side encryption with Key Management
* Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
* server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key,
* or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption setting
* for the target object, you can use other appropriate encryption-related headers to encrypt the target object with
* a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts
* your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the
* encryption setting in your request is different from the default encryption configuration of the destination
* bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in
* Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3
* can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side
* Encryption.
*
*
* If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon
* S3 User Guide.
*
*
* - Access Control List (ACL)-Specific Request Headers
* -
*
* When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects
* are private. Only the owner has full access control. When adding a new object, you can grant permissions to
* individual Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions
* are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview
* and Managing ACLs Using the
* REST API.
*
*
* If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs
* are disabled and no longer affect permissions. Buckets that use this setting only accept PUT
* requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such
* as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML
* format.
*
*
* For more information, see Controlling ownership
* of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by
* any account will be owned by the bucket owner.
*
*
* - Checksums
* -
*
* When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you
* copy the object over, you can optionally specify a different checksum algorithm to use with the
* x-amz-checksum-algorithm header.
*
*
* - Storage Class Options
* -
*
* You can use the CopyObject action to change the storage class of an object that is already stored in
* Amazon S3 by using the StorageClass parameter. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as
* a source object for the copy operation. For more information, see RestoreObject. For more
* information, see Copying
* Objects.
*
*
* - Versioning
* -
*
* By default, x-amz-copy-source header identifies the current version of an object to copy. If the
* current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version,
* use the versionId subresource.
*
*
* If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being
* copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID
* of the copied object in the x-amz-version-id response header in the response.
*
*
* If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is
* always null.
*
*
*
*
* The following operations are related to CopyObject:
*
*
*
* @param copyObjectRequest
* @return A Java Future containing the result of the CopyObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ObjectNotInActiveTierErrorException The source object of the COPY action is not in the active tier
* and is only stored in Amazon S3 Glacier.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CopyObject
*/
default CompletableFuture copyObject(CopyObjectRequest copyObjectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a copy of an object that is already stored in Amazon S3.
*
*
*
* You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size
* in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the
* multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the
* REST Multipart Upload API.
*
*
*
* All copy requests must be authenticated. Additionally, you must have read access to the source object and
* write access to the destination bucket. For more information, see REST Authentication. Both the
* Region that you want to copy the object from and the Region that you want to copy the object to must be enabled
* for your account.
*
*
* A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the
* files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error
* occurs during the copy operation, the error response is embedded in the 200 OK response. This means
* that a 200 OK response can contain either a success or an error. If you call the S3 API directly,
* make sure to design your application to parse the contents of the response and handle it appropriately. If you
* use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error
* handling per your configuration settings (including automatically retrying the request as appropriate). If the
* condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the
* error).
*
*
* If the copy is successful, you receive a response with information about the copied object.
*
*
*
* If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the
* content-length, and you would need to read the entire body.
*
*
*
* The copy request charge is based on the storage class and Region that you specify for the destination object. The
* request can also result in a data retrieval charge for the source if the source storage class bills for data
* retrieval. For pricing information, see Amazon S3 pricing.
*
*
*
* Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a
* transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.
*
*
*
* - Metadata
* -
*
* When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access
* control list (ACL) is not preserved and is set to private for the user making the request. To override the
* default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
*
*
* To specify whether you want the object metadata copied from the source object or replaced with metadata provided
* in the request, you can optionally add the x-amz-metadata-directive header. When you grant
* permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata
* behavior when objects are uploaded. For more information, see Specifying Conditions in a
* Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys
* for Amazon S3.
*
*
*
* x-amz-website-redirect-location is unique to each object and must be specified in the request
* headers to copy the value.
*
*
* - x-amz-copy-source-if Headers
* -
*
* To only copy an object under certain conditions, such as whether the Etag matches or whether the
* object was modified before or after a specified date, use the following request parameters:
*
*
* -
*
* x-amz-copy-source-if-match
*
*
* -
*
* x-amz-copy-source-if-none-match
*
*
* -
*
* x-amz-copy-source-if-unmodified-since
*
*
* -
*
* x-amz-copy-source-if-modified-since
*
*
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the
* data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
*
* All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.
*
*
* - Server-side encryption
* -
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you
* don't specify encryption information in your copy request, the encryption setting of the target object is set to
* the default encryption configuration of the destination bucket. By default, all buckets have a base level of
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
* destination bucket has a default encryption configuration that uses server-side encryption with Key Management
* Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
* server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key,
* or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption setting
* for the target object, you can use other appropriate encryption-related headers to encrypt the target object with
* a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts
* your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the
* encryption setting in your request is different from the default encryption configuration of the destination
* bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in
* Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3
* can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side
* Encryption.
*
*
* If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon
* S3 User Guide.
*
*
* - Access Control List (ACL)-Specific Request Headers
* -
*
* When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects
* are private. Only the owner has full access control. When adding a new object, you can grant permissions to
* individual Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions
* are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview
* and Managing ACLs Using the
* REST API.
*
*
* If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs
* are disabled and no longer affect permissions. Buckets that use this setting only accept PUT
* requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such
* as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML
* format.
*
*
* For more information, see Controlling ownership
* of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by
* any account will be owned by the bucket owner.
*
*
* - Checksums
* -
*
* When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you
* copy the object over, you can optionally specify a different checksum algorithm to use with the
* x-amz-checksum-algorithm header.
*
*
* - Storage Class Options
* -
*
* You can use the CopyObject action to change the storage class of an object that is already stored in
* Amazon S3 by using the StorageClass parameter. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as
* a source object for the copy operation. For more information, see RestoreObject. For more
* information, see Copying
* Objects.
*
*
* - Versioning
* -
*
* By default, x-amz-copy-source header identifies the current version of an object to copy. If the
* current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version,
* use the versionId subresource.
*
*
* If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being
* copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID
* of the copied object in the x-amz-version-id response header in the response.
*
*
* If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is
* always null.
*
*
*
*
* The following operations are related to CopyObject:
*
*
*
*
* This is a convenience which creates an instance of the {@link CopyObjectRequest.Builder} avoiding the need to
* create one manually via {@link CopyObjectRequest#builder()}
*
*
* @param copyObjectRequest
* A {@link Consumer} that will call methods on {@link CopyObjectRequest.Builder} to create a request.
* @return A Java Future containing the result of the CopyObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ObjectNotInActiveTierErrorException The source object of the COPY action is not in the active tier
* and is only stored in Amazon S3 Glacier.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CopyObject
*/
default CompletableFuture copyObject(Consumer copyObjectRequest) {
return copyObject(CopyObjectRequest.builder().applyMutation(copyObjectRequest).build());
}
/**
*
* Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web
* Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By
* creating the bucket, you become the bucket owner.
*
*
* Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.
*
*
* If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
*
*
* By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the
* request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements.
* For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe
* (Ireland) Region. For more information, see Accessing a
* bucket.
*
*
*
* If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the
* us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use
* us-east-1 as the Region, even if the location constraint in the request specifies another Region
* where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your
* application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.
*
*
*
* - Permissions
* -
*
* In addition to s3:CreateBucket, the following permissions are required when your
* CreateBucket request includes specific headers:
*
*
* -
*
* Access control lists (ACLs) - If your CreateBucket request specifies access control list
* (ACL) permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access
* permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl
* permissions are needed. If the ACL for the CreateBucket request is private or if the request doesn't
* specify any ACLs, only s3:CreateBucket permission is needed.
*
*
* -
*
* Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket
* request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are
* required.
*
*
* -
*
* S3 Object Ownership - If your CreateBucket request includes the
* x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is
* required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are
* disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each
* object individually. If you want to change the ObjectOwnership setting, you can use the
* x-amz-object-ownership header in your CreateBucket request to set the
* ObjectOwnership setting of your choice. For more information about S3 Object Ownership, see Controlling object
* ownership in the Amazon S3 User Guide.
*
*
* -
*
* S3 Block Public Access - If your specific use case requires granting public access to your S3 resources,
* you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then
* separately call the
* DeletePublicAccessBlock API. To use this operation, you must have the
* s3:PutBucketPublicAccessBlock permission. By default, all Block Public Access settings are enabled
* for new buckets. To avoid inadvertent exposure of your resources, we recommend keeping the S3 Block Public Access
* settings enabled. For more information about S3 Block Public Access, see Blocking public access
* to your Amazon S3 storage in the Amazon S3 User Guide.
*
*
*
*
*
*
*
* If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership
* and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails
* with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For
* more information, see Setting Object
* Ownership on an existing bucket in the Amazon S3 User Guide.
*
*
*
* The following operations are related to CreateBucket:
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteBucket
*
*
*
*
* @param createBucketRequest
* @return A Java Future containing the result of the CreateBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BucketAlreadyExistsException The requested bucket name is not available. The bucket namespace is
* shared by all users of the system. Select a different name and try again.
* - BucketAlreadyOwnedByYouException The bucket you tried to create already exists, and you own it.
* Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For
* legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia
* Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CreateBucket
*/
default CompletableFuture createBucket(CreateBucketRequest createBucketRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web
* Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By
* creating the bucket, you become the bucket owner.
*
*
* Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.
*
*
* If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
*
*
* By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the
* request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements.
* For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe
* (Ireland) Region. For more information, see Accessing a
* bucket.
*
*
*
* If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the
* us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use
* us-east-1 as the Region, even if the location constraint in the request specifies another Region
* where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your
* application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.
*
*
*
* - Permissions
* -
*
* In addition to s3:CreateBucket, the following permissions are required when your
* CreateBucket request includes specific headers:
*
*
* -
*
* Access control lists (ACLs) - If your CreateBucket request specifies access control list
* (ACL) permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access
* permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl
* permissions are needed. If the ACL for the CreateBucket request is private or if the request doesn't
* specify any ACLs, only s3:CreateBucket permission is needed.
*
*
* -
*
* Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket
* request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are
* required.
*
*
* -
*
* S3 Object Ownership - If your CreateBucket request includes the
* x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is
* required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are
* disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each
* object individually. If you want to change the ObjectOwnership setting, you can use the
* x-amz-object-ownership header in your CreateBucket request to set the
* ObjectOwnership setting of your choice. For more information about S3 Object Ownership, see Controlling object
* ownership in the Amazon S3 User Guide.
*
*
* -
*
* S3 Block Public Access - If your specific use case requires granting public access to your S3 resources,
* you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then
* separately call the
* DeletePublicAccessBlock API. To use this operation, you must have the
* s3:PutBucketPublicAccessBlock permission. By default, all Block Public Access settings are enabled
* for new buckets. To avoid inadvertent exposure of your resources, we recommend keeping the S3 Block Public Access
* settings enabled. For more information about S3 Block Public Access, see Blocking public access
* to your Amazon S3 storage in the Amazon S3 User Guide.
*
*
*
*
*
*
*
* If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership
* and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails
* with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For
* more information, see Setting Object
* Ownership on an existing bucket in the Amazon S3 User Guide.
*
*
*
* The following operations are related to CreateBucket:
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteBucket
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateBucketRequest.Builder} avoiding the need to
* create one manually via {@link CreateBucketRequest#builder()}
*
*
* @param createBucketRequest
* A {@link Consumer} that will call methods on {@link CreateBucketRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - BucketAlreadyExistsException The requested bucket name is not available. The bucket namespace is
* shared by all users of the system. Select a different name and try again.
* - BucketAlreadyOwnedByYouException The bucket you tried to create already exists, and you own it.
* Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For
* legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia
* Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CreateBucket
*/
default CompletableFuture createBucket(Consumer createBucketRequest) {
return createBucket(CreateBucketRequest.builder().applyMutation(createBucketRequest).build());
}
/**
*
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the
* parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part
* requests (see UploadPart). You
* also include this upload ID in the final request to either complete or abort the multipart upload request.
*
*
* For more information about multipart uploads, see Multipart Upload Overview.
*
*
* If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within
* the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload
* becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
*
*
* For information about the permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send
* one or more requests to upload parts, and then complete the multipart upload process. You sign each request
* individually. There is nothing special about signing multipart upload requests. For more information about
* signing, see Authenticating
* Requests (Amazon Web Services Signature Version 4).
*
*
*
* After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the
* uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to
* store the parts and stop charging you for storing them only after you either complete or abort a multipart
* upload.
*
*
*
* Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in
* its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are
* uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your
* request, the encryption setting of the uploaded parts is set to the default encryption configuration of the
* destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side
* encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration
* that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided
* encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the
* uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of
* encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a KMS key, an
* Amazon S3 managed key, or a customer-provided key. If the encryption setting in your request is different from
* the default encryption configuration of the destination bucket, the encryption setting in your request takes
* precedence. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must
* match the headers you used in the request to initiate the upload by using CreateMultipartUpload. You
* can request that Amazon S3 save the uploaded parts encrypted with server-side encryption with an Amazon S3
* managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key
* (SSE-C).
*
*
* To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have
* permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These
* permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it
* completes the multipart upload. For more information, see Multipart upload
* API and permissions and Protecting data using
* server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.
*
*
* If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS
* key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different
* account than the key, then you must have the permissions on both the key policy and your IAM user or role.
*
*
* For more information, see Protecting Data Using
* Server-Side Encryption.
*
*
* - Access Permissions
* -
*
* When copying an object, you can optionally specify the accounts or groups that should be granted specific
* permissions on the new object. There are two ways to grant the permissions using the request headers:
*
*
* -
*
* Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp,
* x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to
* the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
*
*
*
*
* You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
*
*
* - Server-Side- Encryption-Specific Request Headers
* -
*
* Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default.
* Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in
* its data centers and decrypts it when you access it. You can request that Amazon S3 encrypts data at rest by
* using server-side encryption with other key options. The option you use depends on whether you want to use KMS
* keys (SSE-KMS) or provide your own encryption keys (SSE-C).
*
*
* -
*
* Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer
* managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to
* encrypt data, specify the following headers in the request.
*
*
* -
*
* x-amz-server-side-encryption
*
*
* -
*
* x-amz-server-side-encryption-aws-kms-key-id
*
*
* -
*
* x-amz-server-side-encryption-context
*
*
*
*
*
* If you specify x-amz-server-side-encryption:aws:kms, but don't provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (
* aws/s3 key) in KMS to protect the data.
*
*
*
* All GET and PUT requests for an object protected by KMS fail if you don't make them by
* using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4.
*
*
*
* For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using
* Server-Side Encryption with KMS keys.
*
*
* -
*
* Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the
* following headers in the request.
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting
* data using server-side encryption with customer-provided encryption keys (SSE-C).
*
*
*
*
* - Access-Control-List (ACL)-Specific Request Headers
* -
*
* You also can use the following access control–related headers with this operation. By default, all objects are
* private. Only the owner has full access control. When adding a new object, you can grant permissions to
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then
* added to the access control list (ACL) on the object. For more information, see Using ACLs. With this
* operation, you can grant access permissions using one of the following two methods:
*
*
* -
*
* Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned
* ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services
* accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports
* in an ACL. For more information, see Access Control List (ACL) Overview.
* In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly,
* use:
*
*
* -
*
* x-amz-grant-read
*
*
* -
*
* x-amz-grant-write
*
*
* -
*
* x-amz-grant-read-acp
*
*
* -
*
* x-amz-grant-write-acp
*
*
* -
*
* x-amz-grant-full-control
*
*
*
*
* You specify each grantee as a type=value pair, where the type is one of the following:
*
*
* -
*
* id – if the value specified is the canonical user ID of an Amazon Web Services account
*
*
* -
*
* uri – if you are granting permissions to a predefined group
*
*
* -
*
* emailAddress – if the value specified is the email address of an Amazon Web Services account
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
* For example, the following x-amz-grant-read header grants the Amazon Web Services accounts
* identified by account IDs permissions to read object data and its metadata:
*
*
* x-amz-grant-read: id="11112222333", id="444455556666"
*
*
*
*
*
*
* The following operations are related to CreateMultipartUpload:
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
* @param createMultipartUploadRequest
* @return A Java Future containing the result of the CreateMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CreateMultipartUpload
*/
default CompletableFuture createMultipartUpload(
CreateMultipartUploadRequest createMultipartUploadRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the
* parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part
* requests (see UploadPart). You
* also include this upload ID in the final request to either complete or abort the multipart upload request.
*
*
* For more information about multipart uploads, see Multipart Upload Overview.
*
*
* If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within
* the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload
* becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
*
*
* For information about the permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send
* one or more requests to upload parts, and then complete the multipart upload process. You sign each request
* individually. There is nothing special about signing multipart upload requests. For more information about
* signing, see Authenticating
* Requests (Amazon Web Services Signature Version 4).
*
*
*
* After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the
* uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to
* store the parts and stop charging you for storing them only after you either complete or abort a multipart
* upload.
*
*
*
* Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in
* its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are
* uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your
* request, the encryption setting of the uploaded parts is set to the default encryption configuration of the
* destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side
* encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration
* that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided
* encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the
* uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of
* encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a KMS key, an
* Amazon S3 managed key, or a customer-provided key. If the encryption setting in your request is different from
* the default encryption configuration of the destination bucket, the encryption setting in your request takes
* precedence. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must
* match the headers you used in the request to initiate the upload by using CreateMultipartUpload. You
* can request that Amazon S3 save the uploaded parts encrypted with server-side encryption with an Amazon S3
* managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key
* (SSE-C).
*
*
* To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have
* permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These
* permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it
* completes the multipart upload. For more information, see Multipart upload
* API and permissions and Protecting data using
* server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.
*
*
* If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS
* key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different
* account than the key, then you must have the permissions on both the key policy and your IAM user or role.
*
*
* For more information, see Protecting Data Using
* Server-Side Encryption.
*
*
* - Access Permissions
* -
*
* When copying an object, you can optionally specify the accounts or groups that should be granted specific
* permissions on the new object. There are two ways to grant the permissions using the request headers:
*
*
* -
*
* Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp,
* x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to
* the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
*
*
*
*
* You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
*
*
* - Server-Side- Encryption-Specific Request Headers
* -
*
* Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default.
* Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in
* its data centers and decrypts it when you access it. You can request that Amazon S3 encrypts data at rest by
* using server-side encryption with other key options. The option you use depends on whether you want to use KMS
* keys (SSE-KMS) or provide your own encryption keys (SSE-C).
*
*
* -
*
* Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer
* managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to
* encrypt data, specify the following headers in the request.
*
*
* -
*
* x-amz-server-side-encryption
*
*
* -
*
* x-amz-server-side-encryption-aws-kms-key-id
*
*
* -
*
* x-amz-server-side-encryption-context
*
*
*
*
*
* If you specify x-amz-server-side-encryption:aws:kms, but don't provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (
* aws/s3 key) in KMS to protect the data.
*
*
*
* All GET and PUT requests for an object protected by KMS fail if you don't make them by
* using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4.
*
*
*
* For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using
* Server-Side Encryption with KMS keys.
*
*
* -
*
* Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the
* following headers in the request.
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting
* data using server-side encryption with customer-provided encryption keys (SSE-C).
*
*
*
*
* - Access-Control-List (ACL)-Specific Request Headers
* -
*
* You also can use the following access control–related headers with this operation. By default, all objects are
* private. Only the owner has full access control. When adding a new object, you can grant permissions to
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then
* added to the access control list (ACL) on the object. For more information, see Using ACLs. With this
* operation, you can grant access permissions using one of the following two methods:
*
*
* -
*
* Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned
* ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services
* accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports
* in an ACL. For more information, see Access Control List (ACL) Overview.
* In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly,
* use:
*
*
* -
*
* x-amz-grant-read
*
*
* -
*
* x-amz-grant-write
*
*
* -
*
* x-amz-grant-read-acp
*
*
* -
*
* x-amz-grant-write-acp
*
*
* -
*
* x-amz-grant-full-control
*
*
*
*
* You specify each grantee as a type=value pair, where the type is one of the following:
*
*
* -
*
* id – if the value specified is the canonical user ID of an Amazon Web Services account
*
*
* -
*
* uri – if you are granting permissions to a predefined group
*
*
* -
*
* emailAddress – if the value specified is the email address of an Amazon Web Services account
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
* For example, the following x-amz-grant-read header grants the Amazon Web Services accounts
* identified by account IDs permissions to read object data and its metadata:
*
*
* x-amz-grant-read: id="11112222333", id="444455556666"
*
*
*
*
*
*
* The following operations are related to CreateMultipartUpload:
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateMultipartUploadRequest.Builder} avoiding the
* need to create one manually via {@link CreateMultipartUploadRequest#builder()}
*
*
* @param createMultipartUploadRequest
* A {@link Consumer} that will call methods on {@link CreateMultipartUploadRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateMultipartUpload operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.CreateMultipartUpload
*/
default CompletableFuture createMultipartUpload(
Consumer createMultipartUploadRequest) {
return createMultipartUpload(CreateMultipartUploadRequest.builder().applyMutation(createMultipartUploadRequest).build());
}
/**
*
* Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be
* deleted before the bucket itself can be deleted.
*
*
* The following operations are related to DeleteBucket:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteObject
*
*
*
*
* @param deleteBucketRequest
* @return A Java Future containing the result of the DeleteBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucket
*/
default CompletableFuture deleteBucket(DeleteBucketRequest deleteBucketRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be
* deleted before the bucket itself can be deleted.
*
*
* The following operations are related to DeleteBucket:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketRequest.Builder} avoiding the need to
* create one manually via {@link DeleteBucketRequest#builder()}
*
*
* @param deleteBucketRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucket
*/
default CompletableFuture deleteBucket(Consumer deleteBucketRequest) {
return deleteBucket(DeleteBucketRequest.builder().applyMutation(deleteBucketRequest).build());
}
/**
*
* Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
*
*
* To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
* The following operations are related to DeleteBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketAnalyticsConfigurationRequest
* @return A Java Future containing the result of the DeleteBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketAnalyticsConfiguration
*/
default CompletableFuture deleteBucketAnalyticsConfiguration(
DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
*
*
* To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
* The following operations are related to DeleteBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketAnalyticsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBucketAnalyticsConfigurationRequest#builder()}
*
*
* @param deleteBucketAnalyticsConfigurationRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketAnalyticsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketAnalyticsConfiguration
*/
default CompletableFuture deleteBucketAnalyticsConfiguration(
Consumer deleteBucketAnalyticsConfigurationRequest) {
return deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest.builder()
.applyMutation(deleteBucketAnalyticsConfigurationRequest).build());
}
/**
*
* Deletes the cors configuration information set for the bucket.
*
*
* To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket
* owner has this permission by default and can grant this permission to others.
*
*
* For information about cors, see Enabling Cross-Origin Resource Sharing in
* the Amazon S3 User Guide.
*
*
* Related Resources
*
*
* -
*
* PutBucketCors
*
*
* -
*
*
*
*
* @param deleteBucketCorsRequest
* @return A Java Future containing the result of the DeleteBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketCors
*/
default CompletableFuture deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the cors configuration information set for the bucket.
*
*
* To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket
* owner has this permission by default and can grant this permission to others.
*
*
* For information about cors, see Enabling Cross-Origin Resource Sharing in
* the Amazon S3 User Guide.
*
*
* Related Resources
*
*
* -
*
* PutBucketCors
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketCorsRequest.Builder} avoiding the need
* to create one manually via {@link DeleteBucketCorsRequest#builder()}
*
*
* @param deleteBucketCorsRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketCorsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketCors
*/
default CompletableFuture deleteBucketCors(
Consumer deleteBucketCorsRequest) {
return deleteBucketCors(DeleteBucketCorsRequest.builder().applyMutation(deleteBucketCorsRequest).build());
}
/**
*
* This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption
* with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default
* Encryption in the Amazon S3 User Guide.
*
*
* To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
* action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
* For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* The following operations are related to DeleteBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketEncryptionRequest
* @return A Java Future containing the result of the DeleteBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketEncryption
*/
default CompletableFuture deleteBucketEncryption(
DeleteBucketEncryptionRequest deleteBucketEncryptionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption
* with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default
* Encryption in the Amazon S3 User Guide.
*
*
* To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
* action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
* For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* The following operations are related to DeleteBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketEncryptionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBucketEncryptionRequest#builder()}
*
*
* @param deleteBucketEncryptionRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketEncryptionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketEncryption
*/
default CompletableFuture deleteBucketEncryption(
Consumer deleteBucketEncryptionRequest) {
return deleteBucketEncryption(DeleteBucketEncryptionRequest.builder().applyMutation(deleteBucketEncryptionRequest)
.build());
}
/**
*
* Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to DeleteBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketIntelligentTieringConfigurationRequest
* @return A Java Future containing the result of the DeleteBucketIntelligentTieringConfiguration operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketIntelligentTieringConfiguration
*/
default CompletableFuture deleteBucketIntelligentTieringConfiguration(
DeleteBucketIntelligentTieringConfigurationRequest deleteBucketIntelligentTieringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to DeleteBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link DeleteBucketIntelligentTieringConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link DeleteBucketIntelligentTieringConfigurationRequest#builder()}
*
*
* @param deleteBucketIntelligentTieringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link DeleteBucketIntelligentTieringConfigurationRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteBucketIntelligentTieringConfiguration operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketIntelligentTieringConfiguration
*/
default CompletableFuture deleteBucketIntelligentTieringConfiguration(
Consumer deleteBucketIntelligentTieringConfigurationRequest) {
return deleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest.builder()
.applyMutation(deleteBucketIntelligentTieringConfigurationRequest).build());
}
/**
*
* Deletes an inventory configuration (identified by the inventory ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
*
*
* Operations related to DeleteBucketInventoryConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketInventoryConfigurationRequest
* @return A Java Future containing the result of the DeleteBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketInventoryConfiguration
*/
default CompletableFuture deleteBucketInventoryConfiguration(
DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an inventory configuration (identified by the inventory ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
*
*
* Operations related to DeleteBucketInventoryConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketInventoryConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBucketInventoryConfigurationRequest#builder()}
*
*
* @param deleteBucketInventoryConfigurationRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketInventoryConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketInventoryConfiguration
*/
default CompletableFuture deleteBucketInventoryConfiguration(
Consumer deleteBucketInventoryConfigurationRequest) {
return deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest.builder()
.applyMutation(deleteBucketInventoryConfigurationRequest).build());
}
/**
*
* Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration
* rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer
* automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
*
*
* To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action.
* By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
*
*
* There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3
* systems.
*
*
* For more information about the object expiration, see Elements to Describe Lifecycle Actions.
*
*
* Related actions include:
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketLifecycleRequest
* @return A Java Future containing the result of the DeleteBucketLifecycle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketLifecycle
*/
default CompletableFuture deleteBucketLifecycle(
DeleteBucketLifecycleRequest deleteBucketLifecycleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration
* rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer
* automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
*
*
* To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action.
* By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
*
*
* There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3
* systems.
*
*
* For more information about the object expiration, see Elements to Describe Lifecycle Actions.
*
*
* Related actions include:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketLifecycleRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBucketLifecycleRequest#builder()}
*
*
* @param deleteBucketLifecycleRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketLifecycleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketLifecycle operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketLifecycle
*/
default CompletableFuture deleteBucketLifecycle(
Consumer deleteBucketLifecycleRequest) {
return deleteBucketLifecycle(DeleteBucketLifecycleRequest.builder().applyMutation(deleteBucketLifecycleRequest).build());
}
/**
*
* Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration
* ID) from the bucket. Note that this doesn't include the daily storage metrics.
*
*
* To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to DeleteBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketMetricsConfigurationRequest
* @return A Java Future containing the result of the DeleteBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketMetricsConfiguration
*/
default CompletableFuture deleteBucketMetricsConfiguration(
DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration
* ID) from the bucket. Note that this doesn't include the daily storage metrics.
*
*
* To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to DeleteBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketMetricsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBucketMetricsConfigurationRequest#builder()}
*
*
* @param deleteBucketMetricsConfigurationRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketMetricsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketMetricsConfiguration
*/
default CompletableFuture deleteBucketMetricsConfiguration(
Consumer deleteBucketMetricsConfigurationRequest) {
return deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest.builder()
.applyMutation(deleteBucketMetricsConfigurationRequest).build());
}
/**
*
* Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the
* s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
* Policy.
*
*
* For information about Amazon S3 Object Ownership, see Using Object Ownership.
*
*
* The following operations are related to DeleteBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketOwnershipControlsRequest
* @return A Java Future containing the result of the DeleteBucketOwnershipControls operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketOwnershipControls
*/
default CompletableFuture deleteBucketOwnershipControls(
DeleteBucketOwnershipControlsRequest deleteBucketOwnershipControlsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the
* s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
* Policy.
*
*
* For information about Amazon S3 Object Ownership, see Using Object Ownership.
*
*
* The following operations are related to DeleteBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketOwnershipControlsRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBucketOwnershipControlsRequest#builder()}
*
*
* @param deleteBucketOwnershipControlsRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketOwnershipControlsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteBucketOwnershipControls operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketOwnershipControls
*/
default CompletableFuture deleteBucketOwnershipControls(
Consumer deleteBucketOwnershipControlsRequest) {
return deleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest.builder()
.applyMutation(deleteBucketOwnershipControlsRequest).build());
}
/**
*
* This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket.
* If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket,
* the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong
* to the bucket owner's account to use this operation.
*
*
* If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* For more information about bucket policies, see Using Bucket Policies and
* UserPolicies.
*
*
* The following operations are related to DeleteBucketPolicy
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteObject
*
*
*
*
* @param deleteBucketPolicyRequest
* @return A Java Future containing the result of the DeleteBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketPolicy
*/
default CompletableFuture deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket.
* If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket,
* the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong
* to the bucket owner's account to use this operation.
*
*
* If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* For more information about bucket policies, see Using Bucket Policies and
* UserPolicies.
*
*
* The following operations are related to DeleteBucketPolicy
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBucketPolicyRequest#builder()}
*
*
* @param deleteBucketPolicyRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketPolicy
*/
default CompletableFuture deleteBucketPolicy(
Consumer deleteBucketPolicyRequest) {
return deleteBucketPolicy(DeleteBucketPolicyRequest.builder().applyMutation(deleteBucketPolicyRequest).build());
}
/**
*
* Deletes the replication configuration from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
* action. The bucket owner has these permissions by default and can grant it to others. For more information about
* permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
*
* It can take a while for the deletion of a replication configuration to fully propagate.
*
*
*
* For information about replication configuration, see Replication in the Amazon S3 User
* Guide.
*
*
* The following operations are related to DeleteBucketReplication:
*
*
* -
*
*
* -
*
*
*
*
* @param deleteBucketReplicationRequest
* @return A Java Future containing the result of the DeleteBucketReplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketReplication
*/
default CompletableFuture deleteBucketReplication(
DeleteBucketReplicationRequest deleteBucketReplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the replication configuration from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
* action. The bucket owner has these permissions by default and can grant it to others. For more information about
* permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
*
* It can take a while for the deletion of a replication configuration to fully propagate.
*
*
*
* For information about replication configuration, see Replication in the Amazon S3 User
* Guide.
*
*
* The following operations are related to DeleteBucketReplication:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketReplicationRequest.Builder} avoiding
* the need to create one manually via {@link DeleteBucketReplicationRequest#builder()}
*
*
* @param deleteBucketReplicationRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketReplicationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketReplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketReplication
*/
default CompletableFuture deleteBucketReplication(
Consumer deleteBucketReplicationRequest) {
return deleteBucketReplication(DeleteBucketReplicationRequest.builder().applyMutation(deleteBucketReplicationRequest)
.build());
}
/**
*
* Deletes the tags from the bucket.
*
*
* To use this operation, you must have permission to perform the s3:PutBucketTagging action. By
* default, the bucket owner has this permission and can grant this permission to others.
*
*
* The following operations are related to DeleteBucketTagging:
*
*
* -
*
* GetBucketTagging
*
*
* -
*
* PutBucketTagging
*
*
*
*
* @param deleteBucketTaggingRequest
* @return A Java Future containing the result of the DeleteBucketTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketTagging
*/
default CompletableFuture deleteBucketTagging(
DeleteBucketTaggingRequest deleteBucketTaggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the tags from the bucket.
*
*
* To use this operation, you must have permission to perform the s3:PutBucketTagging action. By
* default, the bucket owner has this permission and can grant this permission to others.
*
*
* The following operations are related to DeleteBucketTagging:
*
*
* -
*
* GetBucketTagging
*
*
* -
*
* PutBucketTagging
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketTaggingRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBucketTaggingRequest#builder()}
*
*
* @param deleteBucketTaggingRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketTaggingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketTagging
*/
default CompletableFuture deleteBucketTagging(
Consumer deleteBucketTaggingRequest) {
return deleteBucketTagging(DeleteBucketTaggingRequest.builder().applyMutation(deleteBucketTaggingRequest).build());
}
/**
*
* This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon
* successfully deleting a website configuration on the specified bucket. You will get a 200 OK
* response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a
* 404 response if the bucket specified in the request does not exist.
*
*
* This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner
* can delete the website configuration attached to a bucket. However, bucket owners can grant other users
* permission to delete the website configuration by writing a bucket policy granting them the
* S3:DeleteBucketWebsite permission.
*
*
* For more information about hosting websites, see Hosting Websites on Amazon S3.
*
*
* The following operations are related to DeleteBucketWebsite:
*
*
* -
*
* GetBucketWebsite
*
*
* -
*
* PutBucketWebsite
*
*
*
*
* @param deleteBucketWebsiteRequest
* @return A Java Future containing the result of the DeleteBucketWebsite operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketWebsite
*/
default CompletableFuture deleteBucketWebsite(
DeleteBucketWebsiteRequest deleteBucketWebsiteRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon
* successfully deleting a website configuration on the specified bucket. You will get a 200 OK
* response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a
* 404 response if the bucket specified in the request does not exist.
*
*
* This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner
* can delete the website configuration attached to a bucket. However, bucket owners can grant other users
* permission to delete the website configuration by writing a bucket policy granting them the
* S3:DeleteBucketWebsite permission.
*
*
* For more information about hosting websites, see Hosting Websites on Amazon S3.
*
*
* The following operations are related to DeleteBucketWebsite:
*
*
* -
*
* GetBucketWebsite
*
*
* -
*
* PutBucketWebsite
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBucketWebsiteRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBucketWebsiteRequest#builder()}
*
*
* @param deleteBucketWebsiteRequest
* A {@link Consumer} that will call methods on {@link DeleteBucketWebsiteRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteBucketWebsite operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteBucketWebsite
*/
default CompletableFuture deleteBucketWebsite(
Consumer deleteBucketWebsiteRequest) {
return deleteBucketWebsite(DeleteBucketWebsiteRequest.builder().applyMutation(deleteBucketWebsiteRequest).build());
}
/**
*
* Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
* version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still
* respond that the command was successful.
*
*
* To remove a specific version, you must use the version Id subresource. Using this subresource permanently deletes
* the version. If the object deleted is a delete marker, Amazon S3 sets the response header,
* x-amz-delete-marker, to true.
*
*
* If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled,
* you must include the x-amz-mfa request header in the DELETE versionId request. Requests
* that include x-amz-mfa must use HTTPS.
*
*
* For more information about MFA Delete, see Using MFA Delete. To see sample
* requests that use versioning, see Sample
* Request.
*
*
* You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to
* enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects
* from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and
* s3:PutLifeCycleConfiguration actions.
*
*
* The following action is related to DeleteObject:
*
*
* -
*
* PutObject
*
*
*
*
* @param deleteObjectRequest
* @return A Java Future containing the result of the DeleteObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObject
*/
default CompletableFuture deleteObject(DeleteObjectRequest deleteObjectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
* version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still
* respond that the command was successful.
*
*
* To remove a specific version, you must use the version Id subresource. Using this subresource permanently deletes
* the version. If the object deleted is a delete marker, Amazon S3 sets the response header,
* x-amz-delete-marker, to true.
*
*
* If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled,
* you must include the x-amz-mfa request header in the DELETE versionId request. Requests
* that include x-amz-mfa must use HTTPS.
*
*
* For more information about MFA Delete, see Using MFA Delete. To see sample
* requests that use versioning, see Sample
* Request.
*
*
* You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to
* enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects
* from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and
* s3:PutLifeCycleConfiguration actions.
*
*
* The following action is related to DeleteObject:
*
*
* -
*
* PutObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteObjectRequest.Builder} avoiding the need to
* create one manually via {@link DeleteObjectRequest#builder()}
*
*
* @param deleteObjectRequest
* A {@link Consumer} that will call methods on {@link DeleteObjectRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObject
*/
default CompletableFuture deleteObject(Consumer deleteObjectRequest) {
return deleteObject(DeleteObjectRequest.builder().applyMutation(deleteObjectRequest).build());
}
/**
*
* Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
*
*
* To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.
*
*
* To delete tags of a specific object version, add the versionId query parameter in the request. You
* will need permission for the s3:DeleteObjectVersionTagging action.
*
*
* The following operations are related to DeleteObjectTagging:
*
*
* -
*
* PutObjectTagging
*
*
* -
*
* GetObjectTagging
*
*
*
*
* @param deleteObjectTaggingRequest
* @return A Java Future containing the result of the DeleteObjectTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObjectTagging
*/
default CompletableFuture deleteObjectTagging(
DeleteObjectTaggingRequest deleteObjectTaggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
*
*
* To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.
*
*
* To delete tags of a specific object version, add the versionId query parameter in the request. You
* will need permission for the s3:DeleteObjectVersionTagging action.
*
*
* The following operations are related to DeleteObjectTagging:
*
*
* -
*
* PutObjectTagging
*
*
* -
*
* GetObjectTagging
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteObjectTaggingRequest.Builder} avoiding the
* need to create one manually via {@link DeleteObjectTaggingRequest#builder()}
*
*
* @param deleteObjectTaggingRequest
* A {@link Consumer} that will call methods on {@link DeleteObjectTaggingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteObjectTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObjectTagging
*/
default CompletableFuture deleteObjectTagging(
Consumer deleteObjectTaggingRequest) {
return deleteObjectTagging(DeleteObjectTaggingRequest.builder().applyMutation(deleteObjectTaggingRequest).build());
}
/**
*
* This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the
* object keys that you want to delete, then this action provides a suitable alternative to sending individual
* delete requests, reducing per-request overhead.
*
*
* The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key
* names, and optionally, version IDs if you want to delete a specific version of the object from a
* versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that
* delete, success, or failure, in the response. Note that if the object specified in the request is not found,
* Amazon S3 returns the result as deleted.
*
*
* The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in
* which the response includes the result of deletion of each key in your request. In quiet mode the response
* includes only keys where the delete action encountered an error. For a successful deletion, the action does not
* return any information about the delete in the response body.
*
*
* When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you
* must include an MFA token. If you do not provide one, the entire request will fail, even if there are
* non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys
* in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA
* Delete.
*
*
* Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value
* to ensure that your request body has not been altered in transit.
*
*
* The following operations are related to DeleteObjects:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
* @param deleteObjectsRequest
* @return A Java Future containing the result of the DeleteObjects operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObjects
*/
default CompletableFuture deleteObjects(DeleteObjectsRequest deleteObjectsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the
* object keys that you want to delete, then this action provides a suitable alternative to sending individual
* delete requests, reducing per-request overhead.
*
*
* The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key
* names, and optionally, version IDs if you want to delete a specific version of the object from a
* versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that
* delete, success, or failure, in the response. Note that if the object specified in the request is not found,
* Amazon S3 returns the result as deleted.
*
*
* The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in
* which the response includes the result of deletion of each key in your request. In quiet mode the response
* includes only keys where the delete action encountered an error. For a successful deletion, the action does not
* return any information about the delete in the response body.
*
*
* When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you
* must include an MFA token. If you do not provide one, the entire request will fail, even if there are
* non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys
* in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA
* Delete.
*
*
* Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value
* to ensure that your request body has not been altered in transit.
*
*
* The following operations are related to DeleteObjects:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteObjectsRequest.Builder} avoiding the need to
* create one manually via {@link DeleteObjectsRequest#builder()}
*
*
* @param deleteObjectsRequest
* A {@link Consumer} that will call methods on {@link DeleteObjectsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteObjects operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeleteObjects
*/
default CompletableFuture deleteObjects(Consumer deleteObjectsRequest) {
return deleteObjects(DeleteObjectsRequest.builder().applyMutation(deleteObjectsRequest).build());
}
/**
*
* Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must
* have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The following operations are related to DeletePublicAccessBlock:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param deletePublicAccessBlockRequest
* @return A Java Future containing the result of the DeletePublicAccessBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeletePublicAccessBlock
*/
default CompletableFuture deletePublicAccessBlock(
DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must
* have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The following operations are related to DeletePublicAccessBlock:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeletePublicAccessBlockRequest.Builder} avoiding
* the need to create one manually via {@link DeletePublicAccessBlockRequest#builder()}
*
*
* @param deletePublicAccessBlockRequest
* A {@link Consumer} that will call methods on {@link DeletePublicAccessBlockRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeletePublicAccessBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.DeletePublicAccessBlock
*/
default CompletableFuture deletePublicAccessBlock(
Consumer deletePublicAccessBlockRequest) {
return deletePublicAccessBlock(DeletePublicAccessBlockRequest.builder().applyMutation(deletePublicAccessBlockRequest)
.build());
}
/**
*
* This implementation of the GET action uses the accelerate subresource to return the Transfer
* Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3
* Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from
* Amazon S3.
*
*
* To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended
* by using the
* PutBucketAccelerateConfiguration operation.
*
*
* A GET accelerate request does not return a state value for a bucket that has no transfer
* acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.
*
*
* For more information about transfer acceleration, see Transfer Acceleration in
* the Amazon S3 User Guide.
*
*
* The following operations are related to GetBucketAccelerateConfiguration:
*
*
* -
*
*
*
*
* @param getBucketAccelerateConfigurationRequest
* @return A Java Future containing the result of the GetBucketAccelerateConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAccelerateConfiguration
*/
default CompletableFuture getBucketAccelerateConfiguration(
GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the GET action uses the accelerate subresource to return the Transfer
* Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3
* Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from
* Amazon S3.
*
*
* To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended
* by using the
* PutBucketAccelerateConfiguration operation.
*
*
* A GET accelerate request does not return a state value for a bucket that has no transfer
* acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.
*
*
* For more information about transfer acceleration, see Transfer Acceleration in
* the Amazon S3 User Guide.
*
*
* The following operations are related to GetBucketAccelerateConfiguration:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketAccelerateConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketAccelerateConfigurationRequest#builder()}
*
*
* @param getBucketAccelerateConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketAccelerateConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketAccelerateConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAccelerateConfiguration
*/
default CompletableFuture getBucketAccelerateConfiguration(
Consumer getBucketAccelerateConfigurationRequest) {
return getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest.builder()
.applyMutation(getBucketAccelerateConfigurationRequest).build());
}
/**
*
* This implementation of the GET action uses the acl subresource to return the access
* control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have
* READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user,
* you can return the ACL of the bucket without using an authorization header.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still
* supported and return the bucket-owner-full-control ACL with the owner being the account that created
* the bucket. For more information, see Controlling object
* ownership and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* The following operations are related to GetBucketAcl:
*
*
* -
*
* ListObjects
*
*
*
*
* @param getBucketAclRequest
* @return A Java Future containing the result of the GetBucketAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAcl
*/
default CompletableFuture getBucketAcl(GetBucketAclRequest getBucketAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the GET action uses the acl subresource to return the access
* control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have
* READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user,
* you can return the ACL of the bucket without using an authorization header.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still
* supported and return the bucket-owner-full-control ACL with the owner being the account that created
* the bucket. For more information, see Controlling object
* ownership and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* The following operations are related to GetBucketAcl:
*
*
* -
*
* ListObjects
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketAclRequest.Builder} avoiding the need to
* create one manually via {@link GetBucketAclRequest#builder()}
*
*
* @param getBucketAclRequest
* A {@link Consumer} that will call methods on {@link GetBucketAclRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAcl
*/
default CompletableFuture getBucketAcl(Consumer getBucketAclRequest) {
return getBucketAcl(GetBucketAclRequest.builder().applyMutation(getBucketAclRequest).build());
}
/**
*
* This implementation of the GET action returns an analytics configuration (identified by the analytics
* configuration ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis in the Amazon S3 User Guide.
*
*
* The following operations are related to GetBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketAnalyticsConfigurationRequest
* @return A Java Future containing the result of the GetBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAnalyticsConfiguration
*/
default CompletableFuture getBucketAnalyticsConfiguration(
GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the GET action returns an analytics configuration (identified by the analytics
* configuration ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis in the Amazon S3 User Guide.
*
*
* The following operations are related to GetBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketAnalyticsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketAnalyticsConfigurationRequest#builder()}
*
*
* @param getBucketAnalyticsConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketAnalyticsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketAnalyticsConfiguration
*/
default CompletableFuture getBucketAnalyticsConfiguration(
Consumer getBucketAnalyticsConfigurationRequest) {
return getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest.builder()
.applyMutation(getBucketAnalyticsConfigurationRequest).build());
}
/**
*
* Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
*
*
* To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default,
* the bucket owner has this permission and can grant it to others.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about CORS, see
* Enabling Cross-Origin Resource Sharing.
*
*
* The following operations are related to GetBucketCors:
*
*
* -
*
* PutBucketCors
*
*
* -
*
* DeleteBucketCors
*
*
*
*
* @param getBucketCorsRequest
* @return A Java Future containing the result of the GetBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketCors
*/
default CompletableFuture getBucketCors(GetBucketCorsRequest getBucketCorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
*
*
* To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default,
* the bucket owner has this permission and can grant it to others.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about CORS, see
* Enabling Cross-Origin Resource Sharing.
*
*
* The following operations are related to GetBucketCors:
*
*
* -
*
* PutBucketCors
*
*
* -
*
* DeleteBucketCors
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketCorsRequest.Builder} avoiding the need to
* create one manually via {@link GetBucketCorsRequest#builder()}
*
*
* @param getBucketCorsRequest
* A {@link Consumer} that will call methods on {@link GetBucketCorsRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketCors
*/
default CompletableFuture getBucketCors(Consumer getBucketCorsRequest) {
return getBucketCors(GetBucketCorsRequest.builder().applyMutation(getBucketCorsRequest).build());
}
/**
*
* Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information
* about the bucket default encryption feature, see Amazon S3 Bucket Default
* Encryption in the Amazon S3 User Guide.
*
*
* To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The following operations are related to GetBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketEncryptionRequest
* @return A Java Future containing the result of the GetBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketEncryption
*/
default CompletableFuture getBucketEncryption(
GetBucketEncryptionRequest getBucketEncryptionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information
* about the bucket default encryption feature, see Amazon S3 Bucket Default
* Encryption in the Amazon S3 User Guide.
*
*
* To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The following operations are related to GetBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketEncryptionRequest.Builder} avoiding the
* need to create one manually via {@link GetBucketEncryptionRequest#builder()}
*
*
* @param getBucketEncryptionRequest
* A {@link Consumer} that will call methods on {@link GetBucketEncryptionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketEncryption
*/
default CompletableFuture getBucketEncryption(
Consumer getBucketEncryptionRequest) {
return getBucketEncryption(GetBucketEncryptionRequest.builder().applyMutation(getBucketEncryptionRequest).build());
}
/**
*
* Gets the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to GetBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketIntelligentTieringConfigurationRequest
* @return A Java Future containing the result of the GetBucketIntelligentTieringConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketIntelligentTieringConfiguration
*/
default CompletableFuture getBucketIntelligentTieringConfiguration(
GetBucketIntelligentTieringConfigurationRequest getBucketIntelligentTieringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to GetBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link GetBucketIntelligentTieringConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link GetBucketIntelligentTieringConfigurationRequest#builder()}
*
*
* @param getBucketIntelligentTieringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link GetBucketIntelligentTieringConfigurationRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketIntelligentTieringConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketIntelligentTieringConfiguration
*/
default CompletableFuture getBucketIntelligentTieringConfiguration(
Consumer getBucketIntelligentTieringConfigurationRequest) {
return getBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest.builder()
.applyMutation(getBucketIntelligentTieringConfigurationRequest).build());
}
/**
*
* Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action.
* The bucket owner has this permission by default and can grant this permission to others. For more information
* about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
*
*
* The following operations are related to GetBucketInventoryConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketInventoryConfigurationRequest
* @return A Java Future containing the result of the GetBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketInventoryConfiguration
*/
default CompletableFuture getBucketInventoryConfiguration(
GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
*
*
* To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action.
* The bucket owner has this permission by default and can grant this permission to others. For more information
* about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
*
*
* The following operations are related to GetBucketInventoryConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketInventoryConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketInventoryConfigurationRequest#builder()}
*
*
* @param getBucketInventoryConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketInventoryConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketInventoryConfiguration
*/
default CompletableFuture getBucketInventoryConfiguration(
Consumer getBucketInventoryConfigurationRequest) {
return getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest.builder()
.applyMutation(getBucketInventoryConfigurationRequest).build());
}
/**
*
*
* Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or
* more object tags, or a combination of both. Accordingly, this section describes the latest API. The response
* describes the new filter element that you can use to specify a filter to select a subset of objects to which the
* rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier
* action, see GetBucketLifecycle.
*
*
*
* Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration,
* see Object Lifecycle
* Management.
*
*
* To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action.
* The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* GetBucketLifecycleConfiguration has the following special error:
*
*
* -
*
* Error code: NoSuchLifecycleConfiguration
*
*
* -
*
* Description: The lifecycle configuration does not exist.
*
*
* -
*
* HTTP Status Code: 404 Not Found
*
*
* -
*
* SOAP Fault Code Prefix: Client
*
*
*
*
*
*
* The following operations are related to GetBucketLifecycleConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketLifecycleConfigurationRequest
* @return A Java Future containing the result of the GetBucketLifecycleConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLifecycleConfiguration
*/
default CompletableFuture getBucketLifecycleConfiguration(
GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or
* more object tags, or a combination of both. Accordingly, this section describes the latest API. The response
* describes the new filter element that you can use to specify a filter to select a subset of objects to which the
* rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier
* action, see GetBucketLifecycle.
*
*
*
* Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration,
* see Object Lifecycle
* Management.
*
*
* To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action.
* The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* GetBucketLifecycleConfiguration has the following special error:
*
*
* -
*
* Error code: NoSuchLifecycleConfiguration
*
*
* -
*
* Description: The lifecycle configuration does not exist.
*
*
* -
*
* HTTP Status Code: 404 Not Found
*
*
* -
*
* SOAP Fault Code Prefix: Client
*
*
*
*
*
*
* The following operations are related to GetBucketLifecycleConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketLifecycleConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketLifecycleConfigurationRequest#builder()}
*
*
* @param getBucketLifecycleConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketLifecycleConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketLifecycleConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLifecycleConfiguration
*/
default CompletableFuture getBucketLifecycleConfiguration(
Consumer getBucketLifecycleConfigurationRequest) {
return getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest.builder()
.applyMutation(getBucketLifecycleConfigurationRequest).build());
}
/**
*
* Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
* request parameter in a CreateBucket request. For more information, see CreateBucket.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
*
* We recommend that you use HeadBucket to return the Region
* that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.
*
*
*
* The following operations are related to GetBucketLocation:
*
*
* -
*
* GetObject
*
*
* -
*
* CreateBucket
*
*
*
*
* @param getBucketLocationRequest
* @return A Java Future containing the result of the GetBucketLocation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLocation
*/
default CompletableFuture getBucketLocation(GetBucketLocationRequest getBucketLocationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
* request parameter in a CreateBucket request. For more information, see CreateBucket.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
*
* We recommend that you use HeadBucket to return the Region
* that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.
*
*
*
* The following operations are related to GetBucketLocation:
*
*
* -
*
* GetObject
*
*
* -
*
* CreateBucket
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketLocationRequest.Builder} avoiding the need
* to create one manually via {@link GetBucketLocationRequest#builder()}
*
*
* @param getBucketLocationRequest
* A {@link Consumer} that will call methods on {@link GetBucketLocationRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketLocation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLocation
*/
default CompletableFuture getBucketLocation(
Consumer getBucketLocationRequest) {
return getBucketLocation(GetBucketLocationRequest.builder().applyMutation(getBucketLocationRequest).build());
}
/**
*
* Returns the logging status of a bucket and the permissions users have to view and modify that status.
*
*
* The following operations are related to GetBucketLogging:
*
*
* -
*
* CreateBucket
*
*
* -
*
* PutBucketLogging
*
*
*
*
* @param getBucketLoggingRequest
* @return A Java Future containing the result of the GetBucketLogging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLogging
*/
default CompletableFuture getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the logging status of a bucket and the permissions users have to view and modify that status.
*
*
* The following operations are related to GetBucketLogging:
*
*
* -
*
* CreateBucket
*
*
* -
*
* PutBucketLogging
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketLoggingRequest.Builder} avoiding the need
* to create one manually via {@link GetBucketLoggingRequest#builder()}
*
*
* @param getBucketLoggingRequest
* A {@link Consumer} that will call methods on {@link GetBucketLoggingRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketLogging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketLogging
*/
default CompletableFuture getBucketLogging(
Consumer getBucketLoggingRequest) {
return getBucketLogging(GetBucketLoggingRequest.builder().applyMutation(getBucketLoggingRequest).build());
}
/**
*
* Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't
* include the daily storage metrics.
*
*
* To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to GetBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketMetricsConfigurationRequest
* @return A Java Future containing the result of the GetBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketMetricsConfiguration
*/
default CompletableFuture getBucketMetricsConfiguration(
GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't
* include the daily storage metrics.
*
*
* To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to GetBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketMetricsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketMetricsConfigurationRequest#builder()}
*
*
* @param getBucketMetricsConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketMetricsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketMetricsConfiguration
*/
default CompletableFuture getBucketMetricsConfiguration(
Consumer getBucketMetricsConfigurationRequest) {
return getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest.builder()
.applyMutation(getBucketMetricsConfigurationRequest).build());
}
/**
*
* Returns the notification configuration of a bucket.
*
*
* If notifications are not enabled on the bucket, the action returns an empty
* NotificationConfiguration element.
*
*
* By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket
* owner can use a bucket policy to grant permission to other users to read this configuration with the
* s3:GetBucketNotification permission.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket
* Events. For more information about bucket policies, see Using Bucket Policies.
*
*
* The following action is related to GetBucketNotification:
*
*
* -
*
*
*
*
* @param getBucketNotificationConfigurationRequest
* @return A Java Future containing the result of the GetBucketNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketNotificationConfiguration
*/
default CompletableFuture getBucketNotificationConfiguration(
GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the notification configuration of a bucket.
*
*
* If notifications are not enabled on the bucket, the action returns an empty
* NotificationConfiguration element.
*
*
* By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket
* owner can use a bucket policy to grant permission to other users to read this configuration with the
* s3:GetBucketNotification permission.
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket
* Events. For more information about bucket policies, see Using Bucket Policies.
*
*
* The following action is related to GetBucketNotification:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketNotificationConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link GetBucketNotificationConfigurationRequest#builder()}
*
*
* @param getBucketNotificationConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetBucketNotificationConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetBucketNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketNotificationConfiguration
*/
default CompletableFuture getBucketNotificationConfiguration(
Consumer getBucketNotificationConfigurationRequest) {
return getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest.builder()
.applyMutation(getBucketNotificationConfigurationRequest).build());
}
/**
*
* Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the
* s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in
* a policy.
*
*
* For information about Amazon S3 Object Ownership, see Using Object
* Ownership.
*
*
* The following operations are related to GetBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketOwnershipControlsRequest
* @return A Java Future containing the result of the GetBucketOwnershipControls operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketOwnershipControls
*/
default CompletableFuture getBucketOwnershipControls(
GetBucketOwnershipControlsRequest getBucketOwnershipControlsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the
* s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in
* a policy.
*
*
* For information about Amazon S3 Object Ownership, see Using Object
* Ownership.
*
*
* The following operations are related to GetBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketOwnershipControlsRequest.Builder} avoiding
* the need to create one manually via {@link GetBucketOwnershipControlsRequest#builder()}
*
*
* @param getBucketOwnershipControlsRequest
* A {@link Consumer} that will call methods on {@link GetBucketOwnershipControlsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketOwnershipControls operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketOwnershipControls
*/
default CompletableFuture getBucketOwnershipControls(
Consumer getBucketOwnershipControlsRequest) {
return getBucketOwnershipControls(GetBucketOwnershipControlsRequest.builder()
.applyMutation(getBucketOwnershipControlsRequest).build());
}
/**
*
* Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web
* Services account that owns the bucket, the calling identity must have the GetBucketPolicy
* permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
*
*
* If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about bucket policies, see Using Bucket Policies and User
* Policies.
*
*
* The following action is related to GetBucketPolicy:
*
*
* -
*
* GetObject
*
*
*
*
* @param getBucketPolicyRequest
* @return A Java Future containing the result of the GetBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketPolicy
*/
default CompletableFuture getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web
* Services account that owns the bucket, the calling identity must have the GetBucketPolicy
* permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
*
*
* If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* To use this API operation against an access point, provide the alias of the access point in place of the bucket
* name.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* For more information about bucket policies, see Using Bucket Policies and User
* Policies.
*
*
* The following action is related to GetBucketPolicy:
*
*
* -
*
* GetObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketPolicyRequest.Builder} avoiding the need
* to create one manually via {@link GetBucketPolicyRequest#builder()}
*
*
* @param getBucketPolicyRequest
* A {@link Consumer} that will call methods on {@link GetBucketPolicyRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketPolicy
*/
default CompletableFuture getBucketPolicy(
Consumer getBucketPolicyRequest) {
return getBucketPolicy(GetBucketPolicyRequest.builder().applyMutation(getBucketPolicyRequest).build());
}
/**
*
* Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use
* this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about
* Amazon S3 permissions, see Specifying Permissions in a
* Policy.
*
*
* For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
*
*
* The following operations are related to GetBucketPolicyStatus:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketPolicyStatusRequest
* @return A Java Future containing the result of the GetBucketPolicyStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketPolicyStatus
*/
default CompletableFuture getBucketPolicyStatus(
GetBucketPolicyStatusRequest getBucketPolicyStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use
* this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about
* Amazon S3 permissions, see Specifying Permissions in a
* Policy.
*
*
* For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
*
*
* The following operations are related to GetBucketPolicyStatus:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketPolicyStatusRequest.Builder} avoiding the
* need to create one manually via {@link GetBucketPolicyStatusRequest#builder()}
*
*
* @param getBucketPolicyStatusRequest
* A {@link Consumer} that will call methods on {@link GetBucketPolicyStatusRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketPolicyStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketPolicyStatus
*/
default CompletableFuture getBucketPolicyStatus(
Consumer getBucketPolicyStatusRequest) {
return getBucketPolicyStatus(GetBucketPolicyStatusRequest.builder().applyMutation(getBucketPolicyStatusRequest).build());
}
/**
*
* Returns the replication configuration of a bucket.
*
*
*
* It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems.
* Therefore, a get request soon after put or delete can return a wrong result.
*
*
*
* For information about replication configuration, see Replication in the Amazon S3 User
* Guide.
*
*
* This action requires permissions for the s3:GetReplicationConfiguration action. For more information
* about permissions, see Using
* Bucket Policies and User Policies.
*
*
* If you include the Filter element in a replication configuration, you must also include the
* DeleteMarkerReplication and Priority elements. The response also returns those
* elements.
*
*
* For information about GetBucketReplication errors, see List of
* replication-related error codes
*
*
* The following operations are related to GetBucketReplication:
*
*
* -
*
*
* -
*
*
*
*
* @param getBucketReplicationRequest
* @return A Java Future containing the result of the GetBucketReplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketReplication
*/
default CompletableFuture getBucketReplication(
GetBucketReplicationRequest getBucketReplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the replication configuration of a bucket.
*
*
*
* It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems.
* Therefore, a get request soon after put or delete can return a wrong result.
*
*
*
* For information about replication configuration, see Replication in the Amazon S3 User
* Guide.
*
*
* This action requires permissions for the s3:GetReplicationConfiguration action. For more information
* about permissions, see Using
* Bucket Policies and User Policies.
*
*
* If you include the Filter element in a replication configuration, you must also include the
* DeleteMarkerReplication and Priority elements. The response also returns those
* elements.
*
*
* For information about GetBucketReplication errors, see List of
* replication-related error codes
*
*
* The following operations are related to GetBucketReplication:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketReplicationRequest.Builder} avoiding the
* need to create one manually via {@link GetBucketReplicationRequest#builder()}
*
*
* @param getBucketReplicationRequest
* A {@link Consumer} that will call methods on {@link GetBucketReplicationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketReplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketReplication
*/
default CompletableFuture getBucketReplication(
Consumer getBucketReplicationRequest) {
return getBucketReplication(GetBucketReplicationRequest.builder().applyMutation(getBucketReplicationRequest).build());
}
/**
*
* Returns the request payment configuration of a bucket. To use this version of the operation, you must be the
* bucket owner. For more information, see Requester Pays Buckets.
*
*
* The following operations are related to GetBucketRequestPayment:
*
*
* -
*
* ListObjects
*
*
*
*
* @param getBucketRequestPaymentRequest
* @return A Java Future containing the result of the GetBucketRequestPayment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketRequestPayment
*/
default CompletableFuture getBucketRequestPayment(
GetBucketRequestPaymentRequest getBucketRequestPaymentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the request payment configuration of a bucket. To use this version of the operation, you must be the
* bucket owner. For more information, see Requester Pays Buckets.
*
*
* The following operations are related to GetBucketRequestPayment:
*
*
* -
*
* ListObjects
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketRequestPaymentRequest.Builder} avoiding
* the need to create one manually via {@link GetBucketRequestPaymentRequest#builder()}
*
*
* @param getBucketRequestPaymentRequest
* A {@link Consumer} that will call methods on {@link GetBucketRequestPaymentRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketRequestPayment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketRequestPayment
*/
default CompletableFuture getBucketRequestPayment(
Consumer getBucketRequestPaymentRequest) {
return getBucketRequestPayment(GetBucketRequestPaymentRequest.builder().applyMutation(getBucketRequestPaymentRequest)
.build());
}
/**
*
* Returns the tag set associated with the bucket.
*
*
* To use this operation, you must have permission to perform the s3:GetBucketTagging action. By
* default, the bucket owner has this permission and can grant this permission to others.
*
*
* GetBucketTagging has the following special error:
*
*
* -
*
* Error code: NoSuchTagSet
*
*
* -
*
* Description: There is no tag set associated with the bucket.
*
*
*
*
*
*
* The following operations are related to GetBucketTagging:
*
*
* -
*
* PutBucketTagging
*
*
* -
*
*
*
*
* @param getBucketTaggingRequest
* @return A Java Future containing the result of the GetBucketTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketTagging
*/
default CompletableFuture getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the tag set associated with the bucket.
*
*
* To use this operation, you must have permission to perform the s3:GetBucketTagging action. By
* default, the bucket owner has this permission and can grant this permission to others.
*
*
* GetBucketTagging has the following special error:
*
*
* -
*
* Error code: NoSuchTagSet
*
*
* -
*
* Description: There is no tag set associated with the bucket.
*
*
*
*
*
*
* The following operations are related to GetBucketTagging:
*
*
* -
*
* PutBucketTagging
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketTaggingRequest.Builder} avoiding the need
* to create one manually via {@link GetBucketTaggingRequest#builder()}
*
*
* @param getBucketTaggingRequest
* A {@link Consumer} that will call methods on {@link GetBucketTaggingRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketTagging
*/
default CompletableFuture getBucketTagging(
Consumer getBucketTaggingRequest) {
return getBucketTagging(GetBucketTaggingRequest.builder().applyMutation(getBucketTaggingRequest).build());
}
/**
*
* Returns the versioning state of a bucket.
*
*
* To retrieve the versioning state of a bucket, you must be the bucket owner.
*
*
* This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
* enabled, the bucket owner must use an authentication device to change the versioning state of the
* bucket.
*
*
* The following operations are related to GetBucketVersioning:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
* @param getBucketVersioningRequest
* @return A Java Future containing the result of the GetBucketVersioning operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketVersioning
*/
default CompletableFuture getBucketVersioning(
GetBucketVersioningRequest getBucketVersioningRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the versioning state of a bucket.
*
*
* To retrieve the versioning state of a bucket, you must be the bucket owner.
*
*
* This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
* enabled, the bucket owner must use an authentication device to change the versioning state of the
* bucket.
*
*
* The following operations are related to GetBucketVersioning:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketVersioningRequest.Builder} avoiding the
* need to create one manually via {@link GetBucketVersioningRequest#builder()}
*
*
* @param getBucketVersioningRequest
* A {@link Consumer} that will call methods on {@link GetBucketVersioningRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetBucketVersioning operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketVersioning
*/
default CompletableFuture getBucketVersioning(
Consumer getBucketVersioningRequest) {
return getBucketVersioning(GetBucketVersioningRequest.builder().applyMutation(getBucketVersioningRequest).build());
}
/**
*
* Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as
* website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
*
*
* This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can
* read the bucket website configuration. However, bucket owners can allow other users to read the website
* configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.
*
*
* The following operations are related to GetBucketWebsite:
*
*
* -
*
*
* -
*
* PutBucketWebsite
*
*
*
*
* @param getBucketWebsiteRequest
* @return A Java Future containing the result of the GetBucketWebsite operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketWebsite
*/
default CompletableFuture getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as
* website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
*
*
* This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can
* read the bucket website configuration. However, bucket owners can allow other users to read the website
* configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.
*
*
* The following operations are related to GetBucketWebsite:
*
*
* -
*
*
* -
*
* PutBucketWebsite
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetBucketWebsiteRequest.Builder} avoiding the need
* to create one manually via {@link GetBucketWebsiteRequest#builder()}
*
*
* @param getBucketWebsiteRequest
* A {@link Consumer} that will call methods on {@link GetBucketWebsiteRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetBucketWebsite operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetBucketWebsite
*/
default CompletableFuture getBucketWebsite(
Consumer getBucketWebsiteRequest) {
return getBucketWebsite(GetBucketWebsiteRequest.builder().applyMutation(getBucketWebsiteRequest).build());
}
/**
*
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object.
* If you grant READ access to the anonymous user, you can return the object without using an
* authorization header.
*
*
* An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
* however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
* of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
*
*
* To get an object from such a logical hierarchy, specify the full key name for the object in the GET
* operation. For a virtual hosted-style request example, if you have the object
* photos/2006/February/sample.jpg, specify the resource as
* /photos/2006/February/sample.jpg. For a path-style request example, if you have the object
* photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource
* as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host
* Header Bucket Specification.
*
*
* For more information about returning the ACL of an object, see GetObjectAcl.
*
*
* If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can
* retrieve the object you must first restore a copy using RestoreObject. Otherwise, this
* action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.
*
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests
* if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
* managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request
* error.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you GET the object, you must use the following headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
* Assuming you have the relevant permission to read object tags, the response also returns the
* x-amz-tagging-count header that provides the count of number of tags associated with the object. You
* can use GetObjectTagging
* to retrieve the tag set associated with an object.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a
* Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you
* also have the s3:ListBucket permission.
*
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* (Not Found) error.
*
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
* ("access denied") error.
*
*
* - Versioning
* -
*
* By default, the GET action returns the current version of an object. To return a different version,
* use the versionId subresource.
*
*
*
* -
*
* If you supply a versionId, you need the s3:GetObjectVersion permission to access a
* specific version of an object. If you request a specific version, you do not need to have the
* s3:GetObject permission. If you request the current version without a specific version ID, only
* s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.
*
*
* -
*
* If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
* includes x-amz-delete-marker: true in the response.
*
*
*
*
*
* For more information about versioning, see PutBucketVersioning.
*
*
* - Overriding Response Header Values
* -
*
* There are times when you want to override certain response header values in a GET response. For
* example, you might override the Content-Disposition response header value in your GET
* request.
*
*
* You can override values for a set of response headers using the following query parameters. These response header
* values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
* you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
* object. The response headers that you can override for the GET response are
* Content-Type, Content-Language, Expires, Cache-Control,
* Content-Disposition, and Content-Encoding. To override these header values in the
* GET response, you use the following request parameters.
*
*
*
* You must sign the request, either using an Authorization header or a presigned URL, when using these parameters.
* They cannot be used with an unsigned (anonymous) request.
*
*
*
* -
*
* response-content-type
*
*
* -
*
* response-content-language
*
*
* -
*
* response-expires
*
*
* -
*
* response-cache-control
*
*
* -
*
* response-content-disposition
*
*
* -
*
* response-content-encoding
*
*
*
*
* - Overriding Response Header Values
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows: If-Match condition evaluates to true, and; If-Unmodified-Since
* condition evaluates to false; then, S3 returns 200 OK and the data requested.
*
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows: If-None-Match condition evaluates to false, and;
* If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified
* response code.
*
*
* For more information about conditional requests, see RFC 7232.
*
*
*
*
* The following operations are related to GetObject:
*
*
* -
*
* ListBuckets
*
*
* -
*
* GetObjectAcl
*
*
*
*
* @param getObjectRequest
* @param asyncResponseTransformer
* The response transformer for processing the streaming response in a non-blocking manner. See
* {@link AsyncResponseTransformer} for details on how this callback should be implemented 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.
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - InvalidObjectStateException Object is archived and inaccessible until restored.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObject
*/
default CompletableFuture getObject(GetObjectRequest getObjectRequest,
AsyncResponseTransformer asyncResponseTransformer) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object.
* If you grant READ access to the anonymous user, you can return the object without using an
* authorization header.
*
*
* An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
* however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
* of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
*
*
* To get an object from such a logical hierarchy, specify the full key name for the object in the GET
* operation. For a virtual hosted-style request example, if you have the object
* photos/2006/February/sample.jpg, specify the resource as
* /photos/2006/February/sample.jpg. For a path-style request example, if you have the object
* photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource
* as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host
* Header Bucket Specification.
*
*
* For more information about returning the ACL of an object, see GetObjectAcl.
*
*
* If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can
* retrieve the object you must first restore a copy using RestoreObject. Otherwise, this
* action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.
*
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests
* if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
* managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request
* error.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you GET the object, you must use the following headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
* Assuming you have the relevant permission to read object tags, the response also returns the
* x-amz-tagging-count header that provides the count of number of tags associated with the object. You
* can use GetObjectTagging
* to retrieve the tag set associated with an object.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a
* Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you
* also have the s3:ListBucket permission.
*
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* (Not Found) error.
*
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
* ("access denied") error.
*
*
* - Versioning
* -
*
* By default, the GET action returns the current version of an object. To return a different version,
* use the versionId subresource.
*
*
*
* -
*
* If you supply a versionId, you need the s3:GetObjectVersion permission to access a
* specific version of an object. If you request a specific version, you do not need to have the
* s3:GetObject permission. If you request the current version without a specific version ID, only
* s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.
*
*
* -
*
* If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
* includes x-amz-delete-marker: true in the response.
*
*
*
*
*
* For more information about versioning, see PutBucketVersioning.
*
*
* - Overriding Response Header Values
* -
*
* There are times when you want to override certain response header values in a GET response. For
* example, you might override the Content-Disposition response header value in your GET
* request.
*
*
* You can override values for a set of response headers using the following query parameters. These response header
* values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
* you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
* object. The response headers that you can override for the GET response are
* Content-Type, Content-Language, Expires, Cache-Control,
* Content-Disposition, and Content-Encoding. To override these header values in the
* GET response, you use the following request parameters.
*
*
*
* You must sign the request, either using an Authorization header or a presigned URL, when using these parameters.
* They cannot be used with an unsigned (anonymous) request.
*
*
*
* -
*
* response-content-type
*
*
* -
*
* response-content-language
*
*
* -
*
* response-expires
*
*
* -
*
* response-cache-control
*
*
* -
*
* response-content-disposition
*
*
* -
*
* response-content-encoding
*
*
*
*
* - Overriding Response Header Values
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows: If-Match condition evaluates to true, and; If-Unmodified-Since
* condition evaluates to false; then, S3 returns 200 OK and the data requested.
*
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows: If-None-Match condition evaluates to false, and;
* If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified
* response code.
*
*
* For more information about conditional requests, see RFC 7232.
*
*
*
*
* The following operations are related to GetObject:
*
*
* -
*
* ListBuckets
*
*
* -
*
* GetObjectAcl
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectRequest.Builder} avoiding the need to
* create one manually via {@link GetObjectRequest#builder()}
*
*
* @param getObjectRequest
* A {@link Consumer} that will call methods on {@link GetObjectRequest.Builder} to create a request.
* @param asyncResponseTransformer
* The response transformer for processing the streaming response in a non-blocking manner. See
* {@link AsyncResponseTransformer} for details on how this callback should be implemented 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.
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - InvalidObjectStateException Object is archived and inaccessible until restored.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObject
*/
default CompletableFuture getObject(Consumer getObjectRequest,
AsyncResponseTransformer asyncResponseTransformer) {
return getObject(GetObjectRequest.builder().applyMutation(getObjectRequest).build(), asyncResponseTransformer);
}
/**
*
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object.
* If you grant READ access to the anonymous user, you can return the object without using an
* authorization header.
*
*
* An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
* however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
* of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
*
*
* To get an object from such a logical hierarchy, specify the full key name for the object in the GET
* operation. For a virtual hosted-style request example, if you have the object
* photos/2006/February/sample.jpg, specify the resource as
* /photos/2006/February/sample.jpg. For a path-style request example, if you have the object
* photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource
* as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host
* Header Bucket Specification.
*
*
* For more information about returning the ACL of an object, see GetObjectAcl.
*
*
* If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can
* retrieve the object you must first restore a copy using RestoreObject. Otherwise, this
* action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.
*
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests
* if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
* managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request
* error.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you GET the object, you must use the following headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
* Assuming you have the relevant permission to read object tags, the response also returns the
* x-amz-tagging-count header that provides the count of number of tags associated with the object. You
* can use GetObjectTagging
* to retrieve the tag set associated with an object.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a
* Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you
* also have the s3:ListBucket permission.
*
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* (Not Found) error.
*
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
* ("access denied") error.
*
*
* - Versioning
* -
*
* By default, the GET action returns the current version of an object. To return a different version,
* use the versionId subresource.
*
*
*
* -
*
* If you supply a versionId, you need the s3:GetObjectVersion permission to access a
* specific version of an object. If you request a specific version, you do not need to have the
* s3:GetObject permission. If you request the current version without a specific version ID, only
* s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.
*
*
* -
*
* If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
* includes x-amz-delete-marker: true in the response.
*
*
*
*
*
* For more information about versioning, see PutBucketVersioning.
*
*
* - Overriding Response Header Values
* -
*
* There are times when you want to override certain response header values in a GET response. For
* example, you might override the Content-Disposition response header value in your GET
* request.
*
*
* You can override values for a set of response headers using the following query parameters. These response header
* values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
* you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
* object. The response headers that you can override for the GET response are
* Content-Type, Content-Language, Expires, Cache-Control,
* Content-Disposition, and Content-Encoding. To override these header values in the
* GET response, you use the following request parameters.
*
*
*
* You must sign the request, either using an Authorization header or a presigned URL, when using these parameters.
* They cannot be used with an unsigned (anonymous) request.
*
*
*
* -
*
* response-content-type
*
*
* -
*
* response-content-language
*
*
* -
*
* response-expires
*
*
* -
*
* response-cache-control
*
*
* -
*
* response-content-disposition
*
*
* -
*
* response-content-encoding
*
*
*
*
* - Overriding Response Header Values
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows: If-Match condition evaluates to true, and; If-Unmodified-Since
* condition evaluates to false; then, S3 returns 200 OK and the data requested.
*
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows: If-None-Match condition evaluates to false, and;
* If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified
* response code.
*
*
* For more information about conditional requests, see RFC 7232.
*
*
*
*
* The following operations are related to GetObject:
*
*
* -
*
* ListBuckets
*
*
* -
*
* GetObjectAcl
*
*
*
*
* @param getObjectRequest
* @param destinationPath
* {@link Path} to file that response contents will be written to. The file must not exist or this method
* will throw an exception. If the file is not writable by the current user then an exception will be thrown.
* The service documentation for the response content is as follows '
*
* Object data.
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - InvalidObjectStateException Object is archived and inaccessible until restored.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObject
*/
default CompletableFuture getObject(GetObjectRequest getObjectRequest, Path destinationPath) {
return getObject(getObjectRequest, AsyncResponseTransformer.toFile(destinationPath));
}
/**
*
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object.
* If you grant READ access to the anonymous user, you can return the object without using an
* authorization header.
*
*
* An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
* however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
* of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.
*
*
* To get an object from such a logical hierarchy, specify the full key name for the object in the GET
* operation. For a virtual hosted-style request example, if you have the object
* photos/2006/February/sample.jpg, specify the resource as
* /photos/2006/February/sample.jpg. For a path-style request example, if you have the object
* photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource
* as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host
* Header Bucket Specification.
*
*
* For more information about returning the ACL of an object, see GetObjectAcl.
*
*
* If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can
* retrieve the object you must first restore a copy using RestoreObject. Otherwise, this
* action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.
*
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests
* if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
* managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request
* error.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you GET the object, you must use the following headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
* Assuming you have the relevant permission to read object tags, the response also returns the
* x-amz-tagging-count header that provides the count of number of tags associated with the object. You
* can use GetObjectTagging
* to retrieve the tag set associated with an object.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a
* Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you
* also have the s3:ListBucket permission.
*
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* (Not Found) error.
*
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
* ("access denied") error.
*
*
* - Versioning
* -
*
* By default, the GET action returns the current version of an object. To return a different version,
* use the versionId subresource.
*
*
*
* -
*
* If you supply a versionId, you need the s3:GetObjectVersion permission to access a
* specific version of an object. If you request a specific version, you do not need to have the
* s3:GetObject permission. If you request the current version without a specific version ID, only
* s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.
*
*
* -
*
* If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
* includes x-amz-delete-marker: true in the response.
*
*
*
*
*
* For more information about versioning, see PutBucketVersioning.
*
*
* - Overriding Response Header Values
* -
*
* There are times when you want to override certain response header values in a GET response. For
* example, you might override the Content-Disposition response header value in your GET
* request.
*
*
* You can override values for a set of response headers using the following query parameters. These response header
* values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
* you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
* object. The response headers that you can override for the GET response are
* Content-Type, Content-Language, Expires, Cache-Control,
* Content-Disposition, and Content-Encoding. To override these header values in the
* GET response, you use the following request parameters.
*
*
*
* You must sign the request, either using an Authorization header or a presigned URL, when using these parameters.
* They cannot be used with an unsigned (anonymous) request.
*
*
*
* -
*
* response-content-type
*
*
* -
*
* response-content-language
*
*
* -
*
* response-expires
*
*
* -
*
* response-cache-control
*
*
* -
*
* response-content-disposition
*
*
* -
*
* response-content-encoding
*
*
*
*
* - Overriding Response Header Values
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows: If-Match condition evaluates to true, and; If-Unmodified-Since
* condition evaluates to false; then, S3 returns 200 OK and the data requested.
*
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows: If-None-Match condition evaluates to false, and;
* If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified
* response code.
*
*
* For more information about conditional requests, see RFC 7232.
*
*
*
*
* The following operations are related to GetObject:
*
*
* -
*
* ListBuckets
*
*
* -
*
* GetObjectAcl
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectRequest.Builder} avoiding the need to
* create one manually via {@link GetObjectRequest#builder()}
*
*
* @param getObjectRequest
* A {@link Consumer} that will call methods on {@link GetObjectRequest.Builder} to create a request.
* @param destinationPath
* {@link Path} to file that response contents will be written to. The file must not exist or this method
* will throw an exception. If the file is not writable by the current user then an exception will be thrown.
* The service documentation for the response content is as follows '
*
* Object data.
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - InvalidObjectStateException Object is archived and inaccessible until restored.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObject
*/
default CompletableFuture getObject(Consumer getObjectRequest,
Path destinationPath) {
return getObject(GetObjectRequest.builder().applyMutation(getObjectRequest).build(), destinationPath);
}
/**
*
* Returns the access control list (ACL) of an object. To use this operation, you must have
* s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see
* Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* By default, GET returns ACL information about the current version of an object. To return ACL information about a
* different version, use the versionId subresource.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still
* supported and return the bucket-owner-full-control ACL with the owner being the account that created
* the bucket. For more information, see Controlling object
* ownership and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* The following operations are related to GetObjectAcl:
*
*
* -
*
* GetObject
*
*
* -
*
*
* -
*
* DeleteObject
*
*
* -
*
* PutObject
*
*
*
*
* @param getObjectAclRequest
* @return A Java Future containing the result of the GetObjectAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectAcl
*/
default CompletableFuture getObjectAcl(GetObjectAclRequest getObjectAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the access control list (ACL) of an object. To use this operation, you must have
* s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see
* Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* By default, GET returns ACL information about the current version of an object. To return ACL information about a
* different version, use the versionId subresource.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still
* supported and return the bucket-owner-full-control ACL with the owner being the account that created
* the bucket. For more information, see Controlling object
* ownership and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* The following operations are related to GetObjectAcl:
*
*
* -
*
* GetObject
*
*
* -
*
*
* -
*
* DeleteObject
*
*
* -
*
* PutObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectAclRequest.Builder} avoiding the need to
* create one manually via {@link GetObjectAclRequest#builder()}
*
*
* @param getObjectAclRequest
* A {@link Consumer} that will call methods on {@link GetObjectAclRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetObjectAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectAcl
*/
default CompletableFuture getObjectAcl(Consumer getObjectAclRequest) {
return getObjectAcl(GetObjectAclRequest.builder().applyMutation(getObjectAclRequest).build());
}
/**
*
* Retrieves all the metadata from an object without returning the object itself. This action is useful if you're
* interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to
* the object.
*
*
* GetObjectAttributes combines the functionality of HeadObject and ListParts
* . All of the data returned with each of those individual calls can be returned with a single call to
* GetObjectAttributes.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following
* headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
*
*
*
* -
*
* Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET
* requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web
* Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys (SSE-S3). If your
* object does use these types of keys, you'll get an HTTP 400 Bad Request error.
*
*
* -
*
* The last modified property in this case is the creation date of the object.
*
*
*
*
*
* Consider the following when using request headers:
*
*
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:
*
*
* -
*
* If-Match condition evaluates to true.
*
*
* -
*
* If-Unmodified-Since condition evaluates to false.
*
*
*
*
* -
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:
*
*
* -
*
* If-None-Match condition evaluates to false.
*
*
* -
*
* If-Modified-Since condition evaluates to true.
*
*
*
*
*
*
* For more information about conditional requests, see RFC 7232.
*
*
* - Permissions
* -
*
* The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is
* versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes
* permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and
* s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a
* Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3
* returns depends on whether you also have the s3:ListBucket permission.
*
*
* -
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code
* 404 Not Found ("no such key") error.
*
*
* -
*
* If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code
* 403 Forbidden ("access denied") error.
*
*
*
*
*
*
* The following actions are related to GetObjectAttributes:
*
*
* -
*
* GetObject
*
*
* -
*
* GetObjectAcl
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* GetObjectTagging
*
*
* -
*
* HeadObject
*
*
* -
*
* ListParts
*
*
*
*
* @param getObjectAttributesRequest
* @return A Java Future containing the result of the GetObjectAttributes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectAttributes
*/
default CompletableFuture getObjectAttributes(
GetObjectAttributesRequest getObjectAttributesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all the metadata from an object without returning the object itself. This action is useful if you're
* interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to
* the object.
*
*
* GetObjectAttributes combines the functionality of HeadObject and ListParts
* . All of the data returned with each of those individual calls can be returned with a single call to
* GetObjectAttributes.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following
* headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
*
*
*
* -
*
* Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET
* requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web
* Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys (SSE-S3). If your
* object does use these types of keys, you'll get an HTTP 400 Bad Request error.
*
*
* -
*
* The last modified property in this case is the creation date of the object.
*
*
*
*
*
* Consider the following when using request headers:
*
*
* -
*
* If both of the If-Match and If-Unmodified-Since headers are present in the request as
* follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:
*
*
* -
*
* If-Match condition evaluates to true.
*
*
* -
*
* If-Unmodified-Since condition evaluates to false.
*
*
*
*
* -
*
* If both of the If-None-Match and If-Modified-Since headers are present in the request
* as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:
*
*
* -
*
* If-None-Match condition evaluates to false.
*
*
* -
*
* If-Modified-Since condition evaluates to true.
*
*
*
*
*
*
* For more information about conditional requests, see RFC 7232.
*
*
* - Permissions
* -
*
* The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is
* versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes
* permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and
* s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a
* Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3
* returns depends on whether you also have the s3:ListBucket permission.
*
*
* -
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code
* 404 Not Found ("no such key") error.
*
*
* -
*
* If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code
* 403 Forbidden ("access denied") error.
*
*
*
*
*
*
* The following actions are related to GetObjectAttributes:
*
*
* -
*
* GetObject
*
*
* -
*
* GetObjectAcl
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* GetObjectTagging
*
*
* -
*
* HeadObject
*
*
* -
*
* ListParts
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectAttributesRequest.Builder} avoiding the
* need to create one manually via {@link GetObjectAttributesRequest#builder()}
*
*
* @param getObjectAttributesRequest
* A {@link Consumer} that will call methods on {@link GetObjectAttributesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetObjectAttributes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectAttributes
*/
default CompletableFuture getObjectAttributes(
Consumer getObjectAttributesRequest) {
return getObjectAttributes(GetObjectAttributesRequest.builder().applyMutation(getObjectAttributesRequest).build());
}
/**
*
* Gets an object's current legal hold status. For more information, see Locking Objects.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectLegalHold:
*
*
* -
*
*
*
*
* @param getObjectLegalHoldRequest
* @return A Java Future containing the result of the GetObjectLegalHold operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectLegalHold
*/
default CompletableFuture getObjectLegalHold(GetObjectLegalHoldRequest getObjectLegalHoldRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets an object's current legal hold status. For more information, see Locking Objects.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectLegalHold:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectLegalHoldRequest.Builder} avoiding the
* need to create one manually via {@link GetObjectLegalHoldRequest#builder()}
*
*
* @param getObjectLegalHoldRequest
* A {@link Consumer} that will call methods on {@link GetObjectLegalHoldRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetObjectLegalHold operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectLegalHold
*/
default CompletableFuture getObjectLegalHold(
Consumer getObjectLegalHoldRequest) {
return getObjectLegalHold(GetObjectLegalHoldRequest.builder().applyMutation(getObjectLegalHoldRequest).build());
}
/**
*
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be
* applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
*
*
* The following action is related to GetObjectLockConfiguration:
*
*
* -
*
*
*
*
* @param getObjectLockConfigurationRequest
* @return A Java Future containing the result of the GetObjectLockConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectLockConfiguration
*/
default CompletableFuture getObjectLockConfiguration(
GetObjectLockConfigurationRequest getObjectLockConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be
* applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
*
*
* The following action is related to GetObjectLockConfiguration:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectLockConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link GetObjectLockConfigurationRequest#builder()}
*
*
* @param getObjectLockConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetObjectLockConfigurationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetObjectLockConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectLockConfiguration
*/
default CompletableFuture getObjectLockConfiguration(
Consumer getObjectLockConfigurationRequest) {
return getObjectLockConfiguration(GetObjectLockConfigurationRequest.builder()
.applyMutation(getObjectLockConfigurationRequest).build());
}
/**
*
* Retrieves an object's retention settings. For more information, see Locking Objects.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectRetention:
*
*
* -
*
*
*
*
* @param getObjectRetentionRequest
* @return A Java Future containing the result of the GetObjectRetention operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectRetention
*/
default CompletableFuture getObjectRetention(GetObjectRetentionRequest getObjectRetentionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an object's retention settings. For more information, see Locking Objects.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectRetention:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectRetentionRequest.Builder} avoiding the
* need to create one manually via {@link GetObjectRetentionRequest#builder()}
*
*
* @param getObjectRetentionRequest
* A {@link Consumer} that will call methods on {@link GetObjectRetentionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetObjectRetention operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectRetention
*/
default CompletableFuture getObjectRetention(
Consumer getObjectRetentionRequest) {
return getObjectRetention(GetObjectRetentionRequest.builder().applyMutation(getObjectRetentionRequest).build());
}
/**
*
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the
* object.
*
*
* To use this operation, you must have permission to perform the s3:GetObjectTagging action. By
* default, the GET action returns information about current version of an object. For a versioned bucket, you can
* have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId
* query parameter. You also need permission for the s3:GetObjectVersionTagging action.
*
*
* By default, the bucket owner has this permission and can grant this permission to others.
*
*
* For information about the Amazon S3 object tagging feature, see Object Tagging.
*
*
* The following actions are related to GetObjectTagging:
*
*
* -
*
*
* -
*
*
* -
*
* PutObjectTagging
*
*
*
*
* @param getObjectTaggingRequest
* @return A Java Future containing the result of the GetObjectTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTagging
*/
default CompletableFuture getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the
* object.
*
*
* To use this operation, you must have permission to perform the s3:GetObjectTagging action. By
* default, the GET action returns information about current version of an object. For a versioned bucket, you can
* have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId
* query parameter. You also need permission for the s3:GetObjectVersionTagging action.
*
*
* By default, the bucket owner has this permission and can grant this permission to others.
*
*
* For information about the Amazon S3 object tagging feature, see Object Tagging.
*
*
* The following actions are related to GetObjectTagging:
*
*
* -
*
*
* -
*
*
* -
*
* PutObjectTagging
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectTaggingRequest.Builder} avoiding the need
* to create one manually via {@link GetObjectTaggingRequest#builder()}
*
*
* @param getObjectTaggingRequest
* A {@link Consumer} that will call methods on {@link GetObjectTaggingRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetObjectTagging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTagging
*/
default CompletableFuture getObjectTagging(
Consumer getObjectTaggingRequest) {
return getObjectTagging(GetObjectTaggingRequest.builder().applyMutation(getObjectTaggingRequest).build());
}
/**
*
* Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
*
*
*
* You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using
* server-side encryption with a customer-provided encryption key.
*
*
*
* To use GET, you must have READ access to the object.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectTorrent:
*
*
* -
*
* GetObject
*
*
*
*
* @param getObjectTorrentRequest
* @param asyncResponseTransformer
* The response transformer for processing the streaming response in a non-blocking manner. See
* {@link AsyncResponseTransformer} for details on how this callback should be implemented and for links to
* precanned implementations for common scenarios like downloading to a file. The service documentation for
* the response content is as follows '
*
* A Bencoded dictionary as defined by the BitTorrent specification
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTorrent
*/
default CompletableFuture getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
AsyncResponseTransformer asyncResponseTransformer) {
throw new UnsupportedOperationException();
}
/**
*
* Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
*
*
*
* You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using
* server-side encryption with a customer-provided encryption key.
*
*
*
* To use GET, you must have READ access to the object.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectTorrent:
*
*
* -
*
* GetObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectTorrentRequest.Builder} avoiding the need
* to create one manually via {@link GetObjectTorrentRequest#builder()}
*
*
* @param getObjectTorrentRequest
* A {@link Consumer} that will call methods on {@link GetObjectTorrentRequest.Builder} to create a request.
* @param asyncResponseTransformer
* The response transformer for processing the streaming response in a non-blocking manner. See
* {@link AsyncResponseTransformer} for details on how this callback should be implemented and for links to
* precanned implementations for common scenarios like downloading to a file. The service documentation for
* the response content is as follows '
*
* A Bencoded dictionary as defined by the BitTorrent specification
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTorrent
*/
default CompletableFuture getObjectTorrent(
Consumer getObjectTorrentRequest,
AsyncResponseTransformer asyncResponseTransformer) {
return getObjectTorrent(GetObjectTorrentRequest.builder().applyMutation(getObjectTorrentRequest).build(),
asyncResponseTransformer);
}
/**
*
* Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
*
*
*
* You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using
* server-side encryption with a customer-provided encryption key.
*
*
*
* To use GET, you must have READ access to the object.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectTorrent:
*
*
* -
*
* GetObject
*
*
*
*
* @param getObjectTorrentRequest
* @param destinationPath
* {@link Path} to file that response contents will be written to. The file must not exist or this method
* will throw an exception. If the file is not writable by the current user then an exception will be thrown.
* The service documentation for the response content is as follows '
*
* A Bencoded dictionary as defined by the BitTorrent specification
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTorrent
*/
default CompletableFuture getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
Path destinationPath) {
return getObjectTorrent(getObjectTorrentRequest, AsyncResponseTransformer.toFile(destinationPath));
}
/**
*
* Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
*
*
*
* You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using
* server-side encryption with a customer-provided encryption key.
*
*
*
* To use GET, you must have READ access to the object.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following action is related to GetObjectTorrent:
*
*
* -
*
* GetObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetObjectTorrentRequest.Builder} avoiding the need
* to create one manually via {@link GetObjectTorrentRequest#builder()}
*
*
* @param getObjectTorrentRequest
* A {@link Consumer} that will call methods on {@link GetObjectTorrentRequest.Builder} to create a request.
* @param destinationPath
* {@link Path} to file that response contents will be written to. The file must not exist or this method
* will throw an exception. If the file is not writable by the current user then an exception will be thrown.
* The service documentation for the response content is as follows '
*
* A Bencoded dictionary as defined by the BitTorrent specification
*
* '.
* @return A future to the transformed result of the AsyncResponseTransformer.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetObjectTorrent
*/
default CompletableFuture getObjectTorrent(
Consumer getObjectTorrentRequest, Path destinationPath) {
return getObjectTorrent(GetObjectTorrentRequest.builder().applyMutation(getObjectTorrentRequest).build(), destinationPath);
}
/**
*
* Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you
* must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3
* permissions, see Specifying
* Permissions in a Policy.
*
*
*
* When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks
* the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and
* the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and
* the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
*
*
*
* For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
*
*
* The following operations are related to GetPublicAccessBlock:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param getPublicAccessBlockRequest
* @return A Java Future containing the result of the GetPublicAccessBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetPublicAccessBlock
*/
default CompletableFuture getPublicAccessBlock(
GetPublicAccessBlockRequest getPublicAccessBlockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you
* must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3
* permissions, see Specifying
* Permissions in a Policy.
*
*
*
* When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks
* the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and
* the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and
* the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
*
*
*
* For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
*
*
* The following operations are related to GetPublicAccessBlock:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetPublicAccessBlockRequest.Builder} avoiding the
* need to create one manually via {@link GetPublicAccessBlockRequest#builder()}
*
*
* @param getPublicAccessBlockRequest
* A {@link Consumer} that will call methods on {@link GetPublicAccessBlockRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetPublicAccessBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.GetPublicAccessBlock
*/
default CompletableFuture getPublicAccessBlock(
Consumer getPublicAccessBlockRequest) {
return getPublicAccessBlock(GetPublicAccessBlockRequest.builder().applyMutation(getPublicAccessBlockRequest).build());
}
/**
*
* This action is useful to determine if a bucket exists and you have permission to access it. The action returns a
* 200 OK if the bucket exists and you have permission to access it.
*
*
* If the bucket does not exist or you do not have permission to access it, the HEAD request returns a
* generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message
* body is not included, so you cannot determine the exception beyond these error codes.
*
*
* To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket
* owner has this permission by default and can grant this permission to others. For more information about
* permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* To use this API operation against an access point, you must provide the alias of the access point in place of the
* bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the
* access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web
* Services SDKs, you provide the ARN in place of the bucket name. For more information, see Using access points.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
* @param headBucketRequest
* @return A Java Future containing the result of the HeadBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.HeadBucket
*/
default CompletableFuture headBucket(HeadBucketRequest headBucketRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action is useful to determine if a bucket exists and you have permission to access it. The action returns a
* 200 OK if the bucket exists and you have permission to access it.
*
*
* If the bucket does not exist or you do not have permission to access it, the HEAD request returns a
* generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message
* body is not included, so you cannot determine the exception beyond these error codes.
*
*
* To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket
* owner has this permission by default and can grant this permission to others. For more information about
* permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* To use this API operation against an access point, you must provide the alias of the access point in place of the
* bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the
* access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web
* Services SDKs, you provide the ARN in place of the bucket name. For more information, see Using access points.
*
*
* To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access
* point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error
* code InvalidAccessPointAliasError is returned. For more information about
* InvalidAccessPointAliasError, see List of Error Codes.
*
*
*
* This is a convenience which creates an instance of the {@link HeadBucketRequest.Builder} avoiding the need to
* create one manually via {@link HeadBucketRequest#builder()}
*
*
* @param headBucketRequest
* A {@link Consumer} that will call methods on {@link HeadBucketRequest.Builder} to create a request.
* @return A Java Future containing the result of the HeadBucket operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.HeadBucket
*/
default CompletableFuture headBucket(Consumer headBucketRequest) {
return headBucket(HeadBucketRequest.builder().applyMutation(headBucketRequest).build());
}
/**
*
* The HEAD action retrieves metadata from an object without returning the object itself. This action
* is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access
* to the object.
*
*
* A HEAD request has the same options as a GET action on an object. The response is
* identical to the GET response except that there is no response body. Because of this, if the
* HEAD request generates an error, it returns a generic 400 Bad Request,
* 403 Forbidden or 404 Not Found code. It is not possible to retrieve the exact exception
* beyond these error codes.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following
* headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
*
* -
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for
* GET requests if your object uses server-side encryption with Key Management Service (KMS) keys
* (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
* encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll
* get an HTTP 400 Bad Request error.
*
*
* -
*
* The last modified property in this case is the creation date of the object.
*
*
*
*
*
* Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
*
*
* Consider the following when using request headers:
*
*
* -
*
* Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present
* in the request as follows:
*
*
* -
*
* If-Match condition evaluates to true, and;
*
*
* -
*
* If-Unmodified-Since condition evaluates to false;
*
*
*
*
* Then Amazon S3 returns 200 OK and the data requested.
*
*
* -
*
* Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are
* present in the request as follows:
*
*
* -
*
* If-None-Match condition evaluates to false, and;
*
*
* -
*
* If-Modified-Since condition evaluates to true;
*
*
*
*
* Then Amazon S3 returns the 304 Not Modified response code.
*
*
*
*
* For more information about conditional requests, see RFC 7232.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys
* for Amazon S3. If the object you request doesn't exist, the error that Amazon S3 returns depends on whether
* you also have the s3:ListBucket permission.
*
*
* -
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* error.
*
*
* -
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 error.
*
*
*
*
*
*
* The following actions are related to HeadObject:
*
*
* -
*
* GetObject
*
*
* -
*
*
*
*
* @param headObjectRequest
* @return A Java Future containing the result of the HeadObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.HeadObject
*/
default CompletableFuture headObject(HeadObjectRequest headObjectRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The HEAD action retrieves metadata from an object without returning the object itself. This action
* is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access
* to the object.
*
*
* A HEAD request has the same options as a GET action on an object. The response is
* identical to the GET response except that there is no response body. Because of this, if the
* HEAD request generates an error, it returns a generic 400 Bad Request,
* 403 Forbidden or 404 Not Found code. It is not possible to retrieve the exact exception
* beyond these error codes.
*
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you
* store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following
* headers:
*
*
* -
*
* x-amz-server-side-encryption-customer-algorithm
*
*
* -
*
* x-amz-server-side-encryption-customer-key
*
*
* -
*
* x-amz-server-side-encryption-customer-key-MD5
*
*
*
*
* For more information about SSE-C, see Server-Side
* Encryption (Using Customer-Provided Encryption Keys).
*
*
*
* -
*
* Encryption request headers, like x-amz-server-side-encryption, should not be sent for
* GET requests if your object uses server-side encryption with Key Management Service (KMS) keys
* (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
* encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll
* get an HTTP 400 Bad Request error.
*
*
* -
*
* The last modified property in this case is the creation date of the object.
*
*
*
*
*
* Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
*
*
* Consider the following when using request headers:
*
*
* -
*
* Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present
* in the request as follows:
*
*
* -
*
* If-Match condition evaluates to true, and;
*
*
* -
*
* If-Unmodified-Since condition evaluates to false;
*
*
*
*
* Then Amazon S3 returns 200 OK and the data requested.
*
*
* -
*
* Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are
* present in the request as follows:
*
*
* -
*
* If-None-Match condition evaluates to false, and;
*
*
* -
*
* If-Modified-Since condition evaluates to true;
*
*
*
*
* Then Amazon S3 returns the 304 Not Modified response code.
*
*
*
*
* For more information about conditional requests, see RFC 7232.
*
*
* - Permissions
* -
*
* You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys
* for Amazon S3. If the object you request doesn't exist, the error that Amazon S3 returns depends on whether
* you also have the s3:ListBucket permission.
*
*
* -
*
* If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
* error.
*
*
* -
*
* If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 error.
*
*
*
*
*
*
* The following actions are related to HeadObject:
*
*
* -
*
* GetObject
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link HeadObjectRequest.Builder} avoiding the need to
* create one manually via {@link HeadObjectRequest#builder()}
*
*
* @param headObjectRequest
* A {@link Consumer} that will call methods on {@link HeadObjectRequest.Builder} to create a request.
* @return A Java Future containing the result of the HeadObject operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchKeyException The specified key does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.HeadObject
*/
default CompletableFuture headObject(Consumer headObjectRequest) {
return headObject(HeadObjectRequest.builder().applyMutation(headObjectRequest).build());
}
/**
*
* Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. You should
* always check the IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there will be a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
* The following operations are related to ListBucketAnalyticsConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param listBucketAnalyticsConfigurationsRequest
* @return A Java Future containing the result of the ListBucketAnalyticsConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketAnalyticsConfigurations
*/
default CompletableFuture listBucketAnalyticsConfigurations(
ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. You should
* always check the IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there will be a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
* The following operations are related to ListBucketAnalyticsConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListBucketAnalyticsConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListBucketAnalyticsConfigurationsRequest#builder()}
*
*
* @param listBucketAnalyticsConfigurationsRequest
* A {@link Consumer} that will call methods on {@link ListBucketAnalyticsConfigurationsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListBucketAnalyticsConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketAnalyticsConfigurations
*/
default CompletableFuture listBucketAnalyticsConfigurations(
Consumer listBucketAnalyticsConfigurationsRequest) {
return listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest.builder()
.applyMutation(listBucketAnalyticsConfigurationsRequest).build());
}
/**
*
* Lists the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to ListBucketIntelligentTieringConfigurations include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param listBucketIntelligentTieringConfigurationsRequest
* @return A Java Future containing the result of the ListBucketIntelligentTieringConfigurations operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketIntelligentTieringConfigurations
*/
default CompletableFuture listBucketIntelligentTieringConfigurations(
ListBucketIntelligentTieringConfigurationsRequest listBucketIntelligentTieringConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the S3 Intelligent-Tiering configuration from the specified bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to ListBucketIntelligentTieringConfigurations include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link ListBucketIntelligentTieringConfigurationsRequest.Builder} avoiding the need to create one manually via
* {@link ListBucketIntelligentTieringConfigurationsRequest#builder()}
*
*
* @param listBucketIntelligentTieringConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link ListBucketIntelligentTieringConfigurationsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListBucketIntelligentTieringConfigurations operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketIntelligentTieringConfigurations
*/
default CompletableFuture listBucketIntelligentTieringConfigurations(
Consumer listBucketIntelligentTieringConfigurationsRequest) {
return listBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest.builder()
.applyMutation(listBucketIntelligentTieringConfigurationsRequest).build());
}
/**
*
* Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per
* bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. Always check the
* IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there is a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
*
*
* The following operations are related to ListBucketInventoryConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param listBucketInventoryConfigurationsRequest
* @return A Java Future containing the result of the ListBucketInventoryConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketInventoryConfigurations
*/
default CompletableFuture listBucketInventoryConfigurations(
ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per
* bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. Always check the
* IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there is a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
*
*
* The following operations are related to ListBucketInventoryConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListBucketInventoryConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListBucketInventoryConfigurationsRequest#builder()}
*
*
* @param listBucketInventoryConfigurationsRequest
* A {@link Consumer} that will call methods on {@link ListBucketInventoryConfigurationsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListBucketInventoryConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketInventoryConfigurations
*/
default CompletableFuture listBucketInventoryConfigurations(
Consumer listBucketInventoryConfigurationsRequest) {
return listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest.builder()
.applyMutation(listBucketInventoryConfigurationsRequest).build());
}
/**
*
* Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of
* the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per
* bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. Always check the
* IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there is a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to ListBucketMetricsConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param listBucketMetricsConfigurationsRequest
* @return A Java Future containing the result of the ListBucketMetricsConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketMetricsConfigurations
*/
default CompletableFuture listBucketMetricsConfigurations(
ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of
* the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per
* bucket.
*
*
* This action supports list pagination and does not return more than 100 configurations at a time. Always check the
* IsTruncated element in the response. If there are no more configurations to list,
* IsTruncated is set to false. If there are more configurations to list, IsTruncated is
* set to true, and there is a value in NextContinuationToken. You use the
* NextContinuationToken value to continue the pagination of the list by passing the value in
* continuation-token in the request to GET the next page.
*
*
* To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to ListBucketMetricsConfigurations:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListBucketMetricsConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListBucketMetricsConfigurationsRequest#builder()}
*
*
* @param listBucketMetricsConfigurationsRequest
* A {@link Consumer} that will call methods on {@link ListBucketMetricsConfigurationsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListBucketMetricsConfigurations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBucketMetricsConfigurations
*/
default CompletableFuture listBucketMetricsConfigurations(
Consumer listBucketMetricsConfigurationsRequest) {
return listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest.builder()
.applyMutation(listBucketMetricsConfigurationsRequest).build());
}
/**
*
* Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must
* have the s3:ListAllMyBuckets permission.
*
*
* For information about Amazon S3 buckets, see Creating, configuring, and
* working with Amazon S3 buckets.
*
*
* @param listBucketsRequest
* @return A Java Future containing the result of the ListBuckets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBuckets
*/
default CompletableFuture listBuckets(ListBucketsRequest listBucketsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must
* have the s3:ListAllMyBuckets permission.
*
*
* For information about Amazon S3 buckets, see Creating, configuring, and
* working with Amazon S3 buckets.
*
*
*
* This is a convenience which creates an instance of the {@link ListBucketsRequest.Builder} avoiding the need to
* create one manually via {@link ListBucketsRequest#builder()}
*
*
* @param listBucketsRequest
* A {@link Consumer} that will call methods on {@link ListBucketsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListBuckets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBuckets
*/
default CompletableFuture listBuckets(Consumer listBucketsRequest) {
return listBuckets(ListBucketsRequest.builder().applyMutation(listBucketsRequest).build());
}
/**
*
* Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must
* have the s3:ListAllMyBuckets permission.
*
*
* For information about Amazon S3 buckets, see Creating, configuring, and
* working with Amazon S3 buckets.
*
*
* @return A Java Future containing the result of the ListBuckets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListBuckets
*/
default CompletableFuture listBuckets() {
return listBuckets(ListBucketsRequest.builder().build());
}
/**
*
* This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has
* been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
*
*
* This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
* number of uploads a response can include, which is also the default value. You can further limit the number of
* uploads in a response by specifying the max-uploads parameter in the response. If additional
* multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with
* the value true. To list the additional multipart uploads, use the key-marker and
* upload-id-marker request parameters.
*
*
* In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload
* using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted
* in ascending order within each key by the upload initiation time.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListMultipartUploads:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
* @param listMultipartUploadsRequest
* @return A Java Future containing the result of the ListMultipartUploads operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListMultipartUploads
*/
default CompletableFuture listMultipartUploads(
ListMultipartUploadsRequest listMultipartUploadsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has
* been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
*
*
* This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
* number of uploads a response can include, which is also the default value. You can further limit the number of
* uploads in a response by specifying the max-uploads parameter in the response. If additional
* multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with
* the value true. To list the additional multipart uploads, use the key-marker and
* upload-id-marker request parameters.
*
*
* In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload
* using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted
* in ascending order within each key by the upload initiation time.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListMultipartUploads:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListMultipartUploadsRequest.Builder} avoiding the
* need to create one manually via {@link ListMultipartUploadsRequest#builder()}
*
*
* @param listMultipartUploadsRequest
* A {@link Consumer} that will call methods on {@link ListMultipartUploadsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListMultipartUploads operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListMultipartUploads
*/
default CompletableFuture listMultipartUploads(
Consumer listMultipartUploadsRequest) {
return listMultipartUploads(ListMultipartUploadsRequest.builder().applyMutation(listMultipartUploadsRequest).build());
}
/**
*
* This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has
* been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
*
*
* This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
* number of uploads a response can include, which is also the default value. You can further limit the number of
* uploads in a response by specifying the max-uploads parameter in the response. If additional
* multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with
* the value true. To list the additional multipart uploads, use the key-marker and
* upload-id-marker request parameters.
*
*
* In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload
* using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted
* in ascending order within each key by the upload initiation time.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListMultipartUploads:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a variant of
* {@link #listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxUploads won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)}
* operation.
*
*
* @param listMultipartUploadsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListMultipartUploads
*/
default ListMultipartUploadsPublisher listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest) {
return new ListMultipartUploadsPublisher(this, listMultipartUploadsRequest);
}
/**
*
* This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has
* been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
*
*
* This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
* number of uploads a response can include, which is also the default value. You can further limit the number of
* uploads in a response by specifying the max-uploads parameter in the response. If additional
* multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with
* the value true. To list the additional multipart uploads, use the key-marker and
* upload-id-marker request parameters.
*
*
* In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload
* using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted
* in ascending order within each key by the upload initiation time.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListMultipartUploads:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
* ListParts
*
*
* -
*
*
*
*
*
* This is a variant of
* {@link #listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxUploads won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListMultipartUploadsRequest.Builder} avoiding the
* need to create one manually via {@link ListMultipartUploadsRequest#builder()}
*
*
* @param listMultipartUploadsRequest
* A {@link Consumer} that will call methods on {@link ListMultipartUploadsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListMultipartUploads
*/
default ListMultipartUploadsPublisher listMultipartUploadsPaginator(
Consumer listMultipartUploadsRequest) {
return listMultipartUploadsPaginator(ListMultipartUploadsRequest.builder().applyMutation(listMultipartUploadsRequest)
.build());
}
/**
*
* Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection
* criteria to return metadata about a subset of all the object versions.
*
*
*
* To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be
* aware of the name difference.
*
*
*
* A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse
* the contents of the response and handle it appropriately.
*
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following operations are related to ListObjectVersions:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
* @param listObjectVersionsRequest
* @return A Java Future containing the result of the ListObjectVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectVersions
*/
default CompletableFuture listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection
* criteria to return metadata about a subset of all the object versions.
*
*
*
* To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be
* aware of the name difference.
*
*
*
* A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse
* the contents of the response and handle it appropriately.
*
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following operations are related to ListObjectVersions:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListObjectVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListObjectVersionsRequest#builder()}
*
*
* @param listObjectVersionsRequest
* A {@link Consumer} that will call methods on {@link ListObjectVersionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListObjectVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectVersions
*/
default CompletableFuture listObjectVersions(
Consumer listObjectVersionsRequest) {
return listObjectVersions(ListObjectVersionsRequest.builder().applyMutation(listObjectVersionsRequest).build());
}
/**
*
* Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection
* criteria to return metadata about a subset of all the object versions.
*
*
*
* To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be
* aware of the name difference.
*
*
*
* A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse
* the contents of the response and handle it appropriately.
*
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following operations are related to ListObjectVersions:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a variant of
* {@link #listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)} operation.
*
*
* @param listObjectVersionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectVersions
*/
default ListObjectVersionsPublisher listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest) {
return new ListObjectVersionsPublisher(this, listObjectVersionsRequest);
}
/**
*
* Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection
* criteria to return metadata about a subset of all the object versions.
*
*
*
* To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be
* aware of the name difference.
*
*
*
* A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse
* the contents of the response and handle it appropriately.
*
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* This action is not supported by Amazon S3 on Outposts.
*
*
* The following operations are related to ListObjectVersions:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteObject
*
*
*
*
*
* This is a variant of
* {@link #listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListObjectVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListObjectVersionsRequest#builder()}
*
*
* @param listObjectVersionsRequest
* A {@link Consumer} that will call methods on {@link ListObjectVersionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectVersions
*/
default ListObjectVersionsPublisher listObjectVersionsPaginator(
Consumer listObjectVersionsRequest) {
return listObjectVersionsPaginator(ListObjectVersionsRequest.builder().applyMutation(listObjectVersionsRequest).build());
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
* criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be
* sure to design your application to parse the contents of the response and handle it appropriately.
*
*
*
* This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing
* applications. For backward compatibility, Amazon S3 continues to support ListObjects.
*
*
*
* The following operations are related to ListObjects:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
* -
*
* ListBuckets
*
*
*
*
* @param listObjectsRequest
* @return A Java Future containing the result of the ListObjects operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjects
*/
default CompletableFuture listObjects(ListObjectsRequest listObjectsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
* criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be
* sure to design your application to parse the contents of the response and handle it appropriately.
*
*
*
* This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing
* applications. For backward compatibility, Amazon S3 continues to support ListObjects.
*
*
*
* The following operations are related to ListObjects:
*
*
* -
*
* ListObjectsV2
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
* -
*
* ListBuckets
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListObjectsRequest.Builder} avoiding the need to
* create one manually via {@link ListObjectsRequest#builder()}
*
*
* @param listObjectsRequest
* A {@link Consumer} that will call methods on {@link ListObjectsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListObjects operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjects
*/
default CompletableFuture listObjects(Consumer listObjectsRequest) {
return listObjects(ListObjectsRequest.builder().applyMutation(listObjectsRequest).build());
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request
* parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response
* can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and
* handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the
* list. For more information about listing objects, see Listing object keys
* programmatically in the Amazon S3 User Guide.
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the
* s3:ListBucket action. The bucket owner has this permission by default and can grant this permission
* to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
*
* This section describes the latest revision of this action. We recommend that you use this revised API operation
* for application development. For backward compatibility, Amazon S3 continues to support the prior version of this
* API operation, ListObjects.
*
*
*
* To get a list of your buckets, see ListBuckets.
*
*
* The following operations are related to ListObjectsV2:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
*
*
* @param listObjectsV2Request
* @return A Java Future containing the result of the ListObjectsV2 operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectsV2
*/
default CompletableFuture listObjectsV2(ListObjectsV2Request listObjectsV2Request) {
throw new UnsupportedOperationException();
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request
* parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response
* can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and
* handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the
* list. For more information about listing objects, see Listing object keys
* programmatically in the Amazon S3 User Guide.
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the
* s3:ListBucket action. The bucket owner has this permission by default and can grant this permission
* to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
*
* This section describes the latest revision of this action. We recommend that you use this revised API operation
* for application development. For backward compatibility, Amazon S3 continues to support the prior version of this
* API operation, ListObjects.
*
*
*
* To get a list of your buckets, see ListBuckets.
*
*
* The following operations are related to ListObjectsV2:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListObjectsV2Request.Builder} avoiding the need to
* create one manually via {@link ListObjectsV2Request#builder()}
*
*
* @param listObjectsV2Request
* A {@link Consumer} that will call methods on {@link ListObjectsV2Request.Builder} to create a request.
* @return A Java Future containing the result of the ListObjectsV2 operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectsV2
*/
default CompletableFuture listObjectsV2(Consumer listObjectsV2Request) {
return listObjectsV2(ListObjectsV2Request.builder().applyMutation(listObjectsV2Request).build());
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request
* parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response
* can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and
* handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the
* list. For more information about listing objects, see Listing object keys
* programmatically in the Amazon S3 User Guide.
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the
* s3:ListBucket action. The bucket owner has this permission by default and can grant this permission
* to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
*
* This section describes the latest revision of this action. We recommend that you use this revised API operation
* for application development. For backward compatibility, Amazon S3 continues to support the prior version of this
* API operation, ListObjects.
*
*
*
* To get a list of your buckets, see ListBuckets.
*
*
* The following operations are related to ListObjectsV2:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
*
*
*
* This is a variant of {@link #listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)} operation.
*
*
* @param listObjectsV2Request
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectsV2
*/
default ListObjectsV2Publisher listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request) {
return new ListObjectsV2Publisher(this, listObjectsV2Request);
}
/**
*
* Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request
* parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response
* can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and
* handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the
* list. For more information about listing objects, see Listing object keys
* programmatically in the Amazon S3 User Guide.
*
*
* To use this operation, you must have READ access to the bucket.
*
*
* To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the
* s3:ListBucket action. The bucket owner has this permission by default and can grant this permission
* to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
*
* This section describes the latest revision of this action. We recommend that you use this revised API operation
* for application development. For backward compatibility, Amazon S3 continues to support the prior version of this
* API operation, ListObjects.
*
*
*
* To get a list of your buckets, see ListBuckets.
*
*
* The following operations are related to ListObjectsV2:
*
*
* -
*
* GetObject
*
*
* -
*
* PutObject
*
*
* -
*
* CreateBucket
*
*
*
*
*
* This is a variant of {@link #listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListObjectsV2Request.Builder} avoiding the need to
* create one manually via {@link ListObjectsV2Request#builder()}
*
*
* @param listObjectsV2Request
* A {@link Consumer} that will call methods on {@link ListObjectsV2Request.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - NoSuchBucketException The specified bucket does not exist.
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListObjectsV2
*/
default ListObjectsV2Publisher listObjectsV2Paginator(Consumer listObjectsV2Request) {
return listObjectsV2Paginator(ListObjectsV2Request.builder().applyMutation(listObjectsV2Request).build());
}
/**
*
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
* ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
* This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
* can restrict the number of parts returned by specifying the max-parts request parameter. If your
* multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with
* the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests
* you can include the part-number-marker query string parameter and set its value to the
* NextPartNumberMarker field value from the previous response.
*
*
* If the upload was created using a checksum algorithm, you will need to have permission to the
* kms:Decrypt action for the request to succeed.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListParts:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param listPartsRequest
* @return A Java Future containing the result of the ListParts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListParts
*/
default CompletableFuture listParts(ListPartsRequest listPartsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
* ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
* This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
* can restrict the number of parts returned by specifying the max-parts request parameter. If your
* multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with
* the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests
* you can include the part-number-marker query string parameter and set its value to the
* NextPartNumberMarker field value from the previous response.
*
*
* If the upload was created using a checksum algorithm, you will need to have permission to the
* kms:Decrypt action for the request to succeed.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListParts:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListPartsRequest.Builder} avoiding the need to
* create one manually via {@link ListPartsRequest#builder()}
*
*
* @param listPartsRequest
* A {@link Consumer} that will call methods on {@link ListPartsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListParts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListParts
*/
default CompletableFuture listParts(Consumer listPartsRequest) {
return listParts(ListPartsRequest.builder().applyMutation(listPartsRequest).build());
}
/**
*
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
* ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
* This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
* can restrict the number of parts returned by specifying the max-parts request parameter. If your
* multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with
* the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests
* you can include the part-number-marker query string parameter and set its value to the
* NextPartNumberMarker field value from the previous response.
*
*
* If the upload was created using a checksum algorithm, you will need to have permission to the
* kms:Decrypt action for the request to succeed.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListParts:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a variant of {@link #listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxParts won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)} operation.
*
*
* @param listPartsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListParts
*/
default ListPartsPublisher listPartsPaginator(ListPartsRequest listPartsRequest) {
return new ListPartsPublisher(this, listPartsRequest);
}
/**
*
* Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
* ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
* This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
* can restrict the number of parts returned by specifying the max-parts request parameter. If your
* multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with
* the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests
* you can include the part-number-marker query string parameter and set its value to the
* NextPartNumberMarker field value from the previous response.
*
*
* If the upload was created using a checksum algorithm, you will need to have permission to the
* kms:Decrypt action for the request to succeed.
*
*
* For more information on multipart uploads, see Uploading Objects Using Multipart
* Upload.
*
*
* For information on permissions required to use the multipart upload API, see Multipart Upload and
* Permissions.
*
*
* The following operations are related to ListParts:
*
*
* -
*
*
* -
*
* UploadPart
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a variant of {@link #listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxParts won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListPartsRequest.Builder} avoiding the need to
* create one manually via {@link ListPartsRequest#builder()}
*
*
* @param listPartsRequest
* A {@link Consumer} that will call methods on {@link ListPartsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.ListParts
*/
default ListPartsPublisher listPartsPaginator(Consumer listPartsRequest) {
return listPartsPaginator(ListPartsRequest.builder().applyMutation(listPartsRequest).build());
}
/**
*
* Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level
* feature that enables you to perform faster data transfers to Amazon S3.
*
*
* To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The Transfer Acceleration state of a bucket can be set to one of the following two values:
*
*
* -
*
* Enabled – Enables accelerated data transfers to the bucket.
*
*
* -
*
* Suspended – Disables accelerated data transfers to the bucket.
*
*
*
*
* The
* GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.
*
*
* After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before
* the data transfer rates to the bucket increase.
*
*
* The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").
*
*
* For more information about transfer acceleration, see Transfer Acceleration.
*
*
* The following operations are related to PutBucketAccelerateConfiguration:
*
*
* -
*
*
* -
*
* CreateBucket
*
*
*
*
* @param putBucketAccelerateConfigurationRequest
* @return A Java Future containing the result of the PutBucketAccelerateConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAccelerateConfiguration
*/
default CompletableFuture putBucketAccelerateConfiguration(
PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level
* feature that enables you to perform faster data transfers to Amazon S3.
*
*
* To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* The Transfer Acceleration state of a bucket can be set to one of the following two values:
*
*
* -
*
* Enabled – Enables accelerated data transfers to the bucket.
*
*
* -
*
* Suspended – Disables accelerated data transfers to the bucket.
*
*
*
*
* The
* GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.
*
*
* After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before
* the data transfer rates to the bucket increase.
*
*
* The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").
*
*
* For more information about transfer acceleration, see Transfer Acceleration.
*
*
* The following operations are related to PutBucketAccelerateConfiguration:
*
*
* -
*
*
* -
*
* CreateBucket
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketAccelerateConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketAccelerateConfigurationRequest#builder()}
*
*
* @param putBucketAccelerateConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketAccelerateConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketAccelerateConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAccelerateConfiguration
*/
default CompletableFuture putBucketAccelerateConfiguration(
Consumer putBucketAccelerateConfigurationRequest) {
return putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest.builder()
.applyMutation(putBucketAccelerateConfigurationRequest).build());
}
/**
*
* Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a
* bucket, you must have WRITE_ACP permission.
*
*
* You can use one of the following two ways to set a bucket's permissions:
*
*
* -
*
* Specify the ACL in the request body
*
*
* -
*
* Specify permissions using request headers
*
*
*
*
*
* You cannot specify access permission using both the body and the request headers.
*
*
*
* Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or
* the headers. For example, if you have an existing application that updates a bucket ACL using the request body,
* then you can continue to use that approach.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer
* affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set
* ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read
* ACLs are still supported. For more information, see Controlling object
* ownership in the Amazon S3 User Guide.
*
*
*
* - Permissions
* -
*
* You can set access permissions by using one of the following methods:
*
*
* -
*
* Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs,
* known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned
* ACL name as the value of x-amz-acl. If you use this header, you cannot use other access
* control-specific headers in your request. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp,
* x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers,
* you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will
* receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header
* to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
* information, see Access Control List
* (ACL) Overview.
*
*
* You specify each grantee as a type=value pair, where the type is one of the following:
*
*
* -
*
* id – if the value specified is the canonical user ID of an Amazon Web Services account
*
*
* -
*
* uri – if you are granting permissions to a predefined group
*
*
* -
*
* emailAddress – if the value specified is the email address of an Amazon Web Services account
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
* For example, the following x-amz-grant-write header grants create, overwrite, and delete objects
* permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their
* email addresses.
*
*
* x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
*
*
*
*
* You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
*
*
* - Grantee Values
* -
*
* You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the
* following ways:
*
*
* -
*
* By the person's ID:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
*
*
* DisplayName is optional and ignored in the request
*
*
* -
*
* By URI:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
*
*
* -
*
* By Email address:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>&</Grantee>
*
*
* The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the
* CanonicalUser.
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
*
*
* The following operations are related to PutBucketAcl:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteBucket
*
*
* -
*
* GetObjectAcl
*
*
*
*
* @param putBucketAclRequest
* @return A Java Future containing the result of the PutBucketAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAcl
*/
default CompletableFuture putBucketAcl(PutBucketAclRequest putBucketAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a
* bucket, you must have WRITE_ACP permission.
*
*
* You can use one of the following two ways to set a bucket's permissions:
*
*
* -
*
* Specify the ACL in the request body
*
*
* -
*
* Specify permissions using request headers
*
*
*
*
*
* You cannot specify access permission using both the body and the request headers.
*
*
*
* Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or
* the headers. For example, if you have an existing application that updates a bucket ACL using the request body,
* then you can continue to use that approach.
*
*
*
* If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer
* affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set
* ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read
* ACLs are still supported. For more information, see Controlling object
* ownership in the Amazon S3 User Guide.
*
*
*
* - Permissions
* -
*
* You can set access permissions by using one of the following methods:
*
*
* -
*
* Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs,
* known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned
* ACL name as the value of x-amz-acl. If you use this header, you cannot use other access
* control-specific headers in your request. For more information, see Canned ACL.
*
*
* -
*
* Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp,
* x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers,
* you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will
* receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header
* to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
* information, see Access Control List
* (ACL) Overview.
*
*
* You specify each grantee as a type=value pair, where the type is one of the following:
*
*
* -
*
* id – if the value specified is the canonical user ID of an Amazon Web Services account
*
*
* -
*
* uri – if you are granting permissions to a predefined group
*
*
* -
*
* emailAddress – if the value specified is the email address of an Amazon Web Services account
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
* For example, the following x-amz-grant-write header grants create, overwrite, and delete objects
* permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their
* email addresses.
*
*
* x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
*
*
*
*
* You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
*
*
* - Grantee Values
* -
*
* You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the
* following ways:
*
*
* -
*
* By the person's ID:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
*
*
* DisplayName is optional and ignored in the request
*
*
* -
*
* By URI:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
*
*
* -
*
* By Email address:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>&</Grantee>
*
*
* The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the
* CanonicalUser.
*
*
*
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*
*
* -
*
* US East (N. Virginia)
*
*
* -
*
* US West (N. California)
*
*
* -
*
* US West (Oregon)
*
*
* -
*
* Asia Pacific (Singapore)
*
*
* -
*
* Asia Pacific (Sydney)
*
*
* -
*
* Asia Pacific (Tokyo)
*
*
* -
*
* Europe (Ireland)
*
*
* -
*
* South America (São Paulo)
*
*
*
*
* For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon
* Web Services General Reference.
*
*
*
*
*
*
* The following operations are related to PutBucketAcl:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteBucket
*
*
* -
*
* GetObjectAcl
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketAclRequest.Builder} avoiding the need to
* create one manually via {@link PutBucketAclRequest#builder()}
*
*
* @param putBucketAclRequest
* A {@link Consumer} that will call methods on {@link PutBucketAclRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutBucketAcl operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAcl
*/
default CompletableFuture putBucketAcl(Consumer putBucketAclRequest) {
return putBucketAcl(PutBucketAclRequest.builder().applyMutation(putBucketAclRequest).build());
}
/**
*
* Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to
* 1,000 analytics configurations per bucket.
*
*
* You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat
* file. See the DataExport request element. Reports are updated daily and are based on the object
* filters that you configure. When selecting data export, you specify a destination bucket and an optional
* destination prefix where the file is written. You can export the data to a destination bucket in a different
* account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT
* analytics configuration to. For more information, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
*
* You must create a bucket policy on the destination bucket where the exported file is written to grant permissions
* to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
*
*
*
* To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* PutBucketAnalyticsConfiguration has the following special errors:
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: InvalidArgument
*
*
* -
*
* Cause: Invalid argument.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: TooManyConfigurations
*
*
* -
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 403 Forbidden
*
*
* -
*
* Code: AccessDenied
*
*
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration
* bucket permission to set the configuration on the bucket.
*
*
*
*
*
*
* The following operations are related to PutBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param putBucketAnalyticsConfigurationRequest
* @return A Java Future containing the result of the PutBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAnalyticsConfiguration
*/
default CompletableFuture putBucketAnalyticsConfiguration(
PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to
* 1,000 analytics configurations per bucket.
*
*
* You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat
* file. See the DataExport request element. Reports are updated daily and are based on the object
* filters that you configure. When selecting data export, you specify a destination bucket and an optional
* destination prefix where the file is written. You can export the data to a destination bucket in a different
* account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT
* analytics configuration to. For more information, see Amazon S3 Analytics – Storage
* Class Analysis.
*
*
*
* You must create a bucket policy on the destination bucket where the exported file is written to grant permissions
* to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
*
*
*
* To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* PutBucketAnalyticsConfiguration has the following special errors:
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: InvalidArgument
*
*
* -
*
* Cause: Invalid argument.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 400 Bad Request
*
*
* -
*
* Code: TooManyConfigurations
*
*
* -
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
*
*
* -
*
* -
*
* HTTP Error: HTTP 403 Forbidden
*
*
* -
*
* Code: AccessDenied
*
*
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration
* bucket permission to set the configuration on the bucket.
*
*
*
*
*
*
* The following operations are related to PutBucketAnalyticsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketAnalyticsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketAnalyticsConfigurationRequest#builder()}
*
*
* @param putBucketAnalyticsConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketAnalyticsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketAnalyticsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketAnalyticsConfiguration
*/
default CompletableFuture putBucketAnalyticsConfiguration(
Consumer putBucketAnalyticsConfigurationRequest) {
return putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest.builder()
.applyMutation(putBucketAnalyticsConfigurationRequest).build());
}
/**
*
* Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
*
*
* To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the
* bucket owner has this permission and can grant it to others.
*
*
* You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you
* might want to enable a request whose origin is http://www.example.com to access your Amazon S3
* bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.
*
*
* To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the
* bucket. The cors subresource is an XML document in which you configure rules that identify origins
* and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
*
*
* When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates
* the cors configuration on the bucket and uses the first CORSRule rule that matches the
* incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be
* met:
*
*
* -
*
* The request's Origin header must match AllowedOrigin elements.
*
*
* -
*
* The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
* header in case of a pre-flight OPTIONS request must be one of the AllowedMethod
* elements.
*
*
* -
*
* Every header specified in the Access-Control-Request-Headers request header of a pre-flight request
* must match an AllowedHeader element.
*
*
*
*
* For more information about CORS, go to Enabling Cross-Origin Resource Sharing in
* the Amazon S3 User Guide.
*
*
* The following operations are related to PutBucketCors:
*
*
* -
*
* GetBucketCors
*
*
* -
*
* DeleteBucketCors
*
*
* -
*
*
*
*
* @param putBucketCorsRequest
* @return A Java Future containing the result of the PutBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketCors
*/
default CompletableFuture putBucketCors(PutBucketCorsRequest putBucketCorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
*
*
* To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the
* bucket owner has this permission and can grant it to others.
*
*
* You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you
* might want to enable a request whose origin is http://www.example.com to access your Amazon S3
* bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.
*
*
* To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the
* bucket. The cors subresource is an XML document in which you configure rules that identify origins
* and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
*
*
* When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates
* the cors configuration on the bucket and uses the first CORSRule rule that matches the
* incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be
* met:
*
*
* -
*
* The request's Origin header must match AllowedOrigin elements.
*
*
* -
*
* The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
* header in case of a pre-flight OPTIONS request must be one of the AllowedMethod
* elements.
*
*
* -
*
* Every header specified in the Access-Control-Request-Headers request header of a pre-flight request
* must match an AllowedHeader element.
*
*
*
*
* For more information about CORS, go to Enabling Cross-Origin Resource Sharing in
* the Amazon S3 User Guide.
*
*
* The following operations are related to PutBucketCors:
*
*
* -
*
* GetBucketCors
*
*
* -
*
* DeleteBucketCors
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketCorsRequest.Builder} avoiding the need to
* create one manually via {@link PutBucketCorsRequest#builder()}
*
*
* @param putBucketCorsRequest
* A {@link Consumer} that will call methods on {@link PutBucketCorsRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutBucketCors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketCors
*/
default CompletableFuture putBucketCors(Consumer putBucketCorsRequest) {
return putBucketCors(PutBucketCorsRequest.builder().applyMutation(putBucketCorsRequest).build());
}
/**
*
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket
* Keys for an existing bucket.
*
*
* By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3
* managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side
* encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web
* Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided keys (SSE-C). If you specify
* default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket
* default encryption, see Amazon
* S3 bucket default encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys,
* see Amazon S3 Bucket Keys in the
* Amazon S3 User Guide.
*
*
*
* This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating
* Requests (Amazon Web Services Signature Version 4).
*
*
*
* To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* The following operations are related to PutBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
* @param putBucketEncryptionRequest
* @return A Java Future containing the result of the PutBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketEncryption
*/
default CompletableFuture putBucketEncryption(
PutBucketEncryptionRequest putBucketEncryptionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket
* Keys for an existing bucket.
*
*
* By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3
* managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side
* encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web
* Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided keys (SSE-C). If you specify
* default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket
* default encryption, see Amazon
* S3 bucket default encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys,
* see Amazon S3 Bucket Keys in the
* Amazon S3 User Guide.
*
*
*
* This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating
* Requests (Amazon Web Services Signature Version 4).
*
*
*
* To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* The following operations are related to PutBucketEncryption:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketEncryptionRequest.Builder} avoiding the
* need to create one manually via {@link PutBucketEncryptionRequest#builder()}
*
*
* @param putBucketEncryptionRequest
* A {@link Consumer} that will call methods on {@link PutBucketEncryptionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutBucketEncryption operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketEncryption
*/
default CompletableFuture putBucketEncryption(
Consumer putBucketEncryptionRequest) {
return putBucketEncryption(PutBucketEncryptionRequest.builder().applyMutation(putBucketEncryptionRequest).build());
}
/**
*
* Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3
* Intelligent-Tiering configurations per bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to PutBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the
* S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
*
*
*
* PutBucketIntelligentTieringConfiguration has the following special errors:
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: InvalidArgument
*
*
* Cause: Invalid Argument
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: TooManyConfigurations
*
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* - HTTP 403 Forbidden Error
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the
* s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.
*
*
*
*
* @param putBucketIntelligentTieringConfigurationRequest
* @return A Java Future containing the result of the PutBucketIntelligentTieringConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketIntelligentTieringConfiguration
*/
default CompletableFuture putBucketIntelligentTieringConfiguration(
PutBucketIntelligentTieringConfigurationRequest putBucketIntelligentTieringConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3
* Intelligent-Tiering configurations per bucket.
*
*
* The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to
* the most cost-effective storage access tier, without performance impact or operational overhead. S3
* Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get
* the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional
* archiving capabilities.
*
*
* The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or
* unpredictable access patterns, independent of object size or retention period. If the size of an object is less
* than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are
* always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
*
*
* For more information, see Storage
* class for automatically optimizing frequently and infrequently accessed objects.
*
*
* Operations related to PutBucketIntelligentTieringConfiguration include:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the
* S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
*
*
*
* PutBucketIntelligentTieringConfiguration has the following special errors:
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: InvalidArgument
*
*
* Cause: Invalid Argument
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: TooManyConfigurations
*
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* - HTTP 403 Forbidden Error
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the
* s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link PutBucketIntelligentTieringConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link PutBucketIntelligentTieringConfigurationRequest#builder()}
*
*
* @param putBucketIntelligentTieringConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link PutBucketIntelligentTieringConfigurationRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutBucketIntelligentTieringConfiguration operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketIntelligentTieringConfiguration
*/
default CompletableFuture putBucketIntelligentTieringConfiguration(
Consumer putBucketIntelligentTieringConfigurationRequest) {
return putBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest.builder()
.applyMutation(putBucketIntelligentTieringConfigurationRequest).build());
}
/**
*
* This implementation of the PUT action adds an inventory configuration (identified by the inventory
* ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
*
*
* Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the
* results are published to a flat file. The bucket that is inventoried is called the source bucket, and the
* bucket where the inventory flat file is stored is called the destination bucket. The destination
* bucket must be in the same Amazon Web Services Region as the source bucket.
*
*
* When you configure an inventory for a source bucket, you specify the destination bucket where you
* want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure
* what object metadata to include and whether to inventory all object versions or only current versions. For more
* information, see Amazon S3
* Inventory in the Amazon S3 User Guide.
*
*
*
* You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write
* objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
*
*
*
* - Permissions
* -
*
* To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action.
* The bucket owner has this permission by default and can grant this permission to others.
*
*
* The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that
* includes all object metadata fields available and to specify the destination bucket to store the inventory. A
* user with read access to objects in the destination bucket can also access all object metadata fields that are
* available in the inventory report.
*
*
* To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information
* about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access
* management in Amazon S3 in the Amazon S3 User Guide.
*
*
*
*
* PutBucketInventoryConfiguration has the following special errors:
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: InvalidArgument
*
*
* Cause: Invalid Argument
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: TooManyConfigurations
*
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* - HTTP 403 Forbidden Error
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the
* s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.
*
*
*
*
* The following operations are related to PutBucketInventoryConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param putBucketInventoryConfigurationRequest
* @return A Java Future containing the result of the PutBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketInventoryConfiguration
*/
default CompletableFuture putBucketInventoryConfiguration(
PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This implementation of the PUT action adds an inventory configuration (identified by the inventory
* ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
*
*
* Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the
* results are published to a flat file. The bucket that is inventoried is called the source bucket, and the
* bucket where the inventory flat file is stored is called the destination bucket. The destination
* bucket must be in the same Amazon Web Services Region as the source bucket.
*
*
* When you configure an inventory for a source bucket, you specify the destination bucket where you
* want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure
* what object metadata to include and whether to inventory all object versions or only current versions. For more
* information, see Amazon S3
* Inventory in the Amazon S3 User Guide.
*
*
*
* You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write
* objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
*
*
*
* - Permissions
* -
*
* To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action.
* The bucket owner has this permission by default and can grant this permission to others.
*
*
* The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that
* includes all object metadata fields available and to specify the destination bucket to store the inventory. A
* user with read access to objects in the destination bucket can also access all object metadata fields that are
* available in the inventory report.
*
*
* To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information
* about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access
* management in Amazon S3 in the Amazon S3 User Guide.
*
*
*
*
* PutBucketInventoryConfiguration has the following special errors:
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: InvalidArgument
*
*
* Cause: Invalid Argument
*
*
* - HTTP 400 Bad Request Error
* -
*
* Code: TooManyConfigurations
*
*
* Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* - HTTP 403 Forbidden Error
* -
*
* Cause: You are not the owner of the specified bucket, or you do not have the
* s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.
*
*
*
*
* The following operations are related to PutBucketInventoryConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketInventoryConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketInventoryConfigurationRequest#builder()}
*
*
* @param putBucketInventoryConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketInventoryConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketInventoryConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketInventoryConfiguration
*/
default CompletableFuture putBucketInventoryConfiguration(
Consumer putBucketInventoryConfigurationRequest) {
return putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest.builder()
.applyMutation(putBucketInventoryConfigurationRequest).build());
}
/**
*
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in
* mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration
* details, they must be included in the new lifecycle configuration. For information about lifecycle configuration,
* see Managing your
* storage lifecycle.
*
*
*
* Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or
* more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous
* version of the API supported filtering based only on an object key name prefix, which is supported for backward
* compatibility. For the related API description, see PutBucketLifecycle.
*
*
*
* - Rules
* -
*
* You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML
* consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is
* not adjustable. Each rule consists of the following:
*
*
* -
*
* A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix,
* object tags, or a combination of both.
*
*
* -
*
* A status indicating whether the rule is in effect.
*
*
* -
*
* One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects
* identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have
* many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides
* predefined actions that you can specify for current and noncurrent object versions.
*
*
*
*
* For more information, see Object Lifecycle Management
* and Lifecycle Configuration
* Elements.
*
*
* - Permissions
* -
*
* By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for
* example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web
* Services account that created it) can access the resource. The resource owner can optionally grant access
* permissions to others by writing an access policy. For this operation, a user must get the
* s3:PutLifecycleConfiguration permission.
*
*
* You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to
* block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for
* the following actions:
*
*
* -
*
* s3:DeleteObject
*
*
* -
*
* s3:DeleteObjectVersion
*
*
* -
*
* s3:PutLifecycleConfiguration
*
*
*
*
* For more information about permissions, see Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
*
*
* The following operations are related to PutBucketLifecycleConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param putBucketLifecycleConfigurationRequest
* @return A Java Future containing the result of the PutBucketLifecycleConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketLifecycleConfiguration
*/
default CompletableFuture putBucketLifecycleConfiguration(
PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in
* mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration
* details, they must be included in the new lifecycle configuration. For information about lifecycle configuration,
* see Managing your
* storage lifecycle.
*
*
*
* Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or
* more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous
* version of the API supported filtering based only on an object key name prefix, which is supported for backward
* compatibility. For the related API description, see PutBucketLifecycle.
*
*
*
* - Rules
* -
*
* You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML
* consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is
* not adjustable. Each rule consists of the following:
*
*
* -
*
* A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix,
* object tags, or a combination of both.
*
*
* -
*
* A status indicating whether the rule is in effect.
*
*
* -
*
* One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects
* identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have
* many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides
* predefined actions that you can specify for current and noncurrent object versions.
*
*
*
*
* For more information, see Object Lifecycle Management
* and Lifecycle Configuration
* Elements.
*
*
* - Permissions
* -
*
* By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for
* example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web
* Services account that created it) can access the resource. The resource owner can optionally grant access
* permissions to others by writing an access policy. For this operation, a user must get the
* s3:PutLifecycleConfiguration permission.
*
*
* You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to
* block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for
* the following actions:
*
*
* -
*
* s3:DeleteObject
*
*
* -
*
* s3:DeleteObjectVersion
*
*
* -
*
* s3:PutLifecycleConfiguration
*
*
*
*
* For more information about permissions, see Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
*
*
* The following operations are related to PutBucketLifecycleConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketLifecycleConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketLifecycleConfigurationRequest#builder()}
*
*
* @param putBucketLifecycleConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketLifecycleConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketLifecycleConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketLifecycleConfiguration
*/
default CompletableFuture putBucketLifecycleConfiguration(
Consumer putBucketLifecycleConfigurationRequest) {
return putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest.builder()
.applyMutation(putBucketLifecycleConfigurationRequest).build());
}
/**
*
* Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
* parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the
* logging status of a bucket, you must be the bucket owner.
*
*
* The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request
* element to grant access to other people. The Permissions request element specifies the kind of
* access the grantee has to the logs.
*
*
*
* If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't
* use the Grantee request element to grant access to others. Permissions can only be granted using
* policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
*
*
*
* - Grantee Values
* -
*
* You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the
* following ways:
*
*
* -
*
* By the person's ID:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
*
*
* DisplayName is optional and ignored in the request.
*
*
* -
*
* By Email address:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress></Grantee>
*
*
* The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl
* request, appears as the CanonicalUser.
*
*
* -
*
* By URI:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
*
*
*
*
*
*
* To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you
* use an empty BucketLoggingStatus request element:
*
*
* <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
*
*
* For more information about server access logging, see Server Access Logging in the
* Amazon S3 User Guide.
*
*
* For more information about creating a bucket, see CreateBucket. For more
* information about returning the logging status of a bucket, see GetBucketLogging.
*
*
* The following operations are related to PutBucketLogging:
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteBucket
*
*
* -
*
* CreateBucket
*
*
* -
*
* GetBucketLogging
*
*
*
*
* @param putBucketLoggingRequest
* @return A Java Future containing the result of the PutBucketLogging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketLogging
*/
default CompletableFuture putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
* parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the
* logging status of a bucket, you must be the bucket owner.
*
*
* The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request
* element to grant access to other people. The Permissions request element specifies the kind of
* access the grantee has to the logs.
*
*
*
* If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't
* use the Grantee request element to grant access to others. Permissions can only be granted using
* policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
*
*
*
* - Grantee Values
* -
*
* You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the
* following ways:
*
*
* -
*
* By the person's ID:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
*
*
* DisplayName is optional and ignored in the request.
*
*
* -
*
* By Email address:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress></Grantee>
*
*
* The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl
* request, appears as the CanonicalUser.
*
*
* -
*
* By URI:
*
*
* <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
*
*
*
*
*
*
* To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you
* use an empty BucketLoggingStatus request element:
*
*
* <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
*
*
* For more information about server access logging, see Server Access Logging in the
* Amazon S3 User Guide.
*
*
* For more information about creating a bucket, see CreateBucket. For more
* information about returning the logging status of a bucket, see GetBucketLogging.
*
*
* The following operations are related to PutBucketLogging:
*
*
* -
*
* PutObject
*
*
* -
*
* DeleteBucket
*
*
* -
*
* CreateBucket
*
*
* -
*
* GetBucketLogging
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketLoggingRequest.Builder} avoiding the need
* to create one manually via {@link PutBucketLoggingRequest#builder()}
*
*
* @param putBucketLoggingRequest
* A {@link Consumer} that will call methods on {@link PutBucketLoggingRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutBucketLogging operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketLogging
*/
default CompletableFuture putBucketLogging(
Consumer putBucketLoggingRequest) {
return putBucketLogging(PutBucketLoggingRequest.builder().applyMutation(putBucketLoggingRequest).build());
}
/**
*
* Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000
* metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full
* replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are
* erased.
*
*
* To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to PutBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* PutBucketMetricsConfiguration has the following special error:
*
*
* -
*
* Error code: TooManyConfigurations
*
*
* -
*
* Description: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* -
*
* HTTP Status Code: HTTP 400 Bad Request
*
*
*
*
*
*
* @param putBucketMetricsConfigurationRequest
* @return A Java Future containing the result of the PutBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketMetricsConfiguration
*/
default CompletableFuture putBucketMetricsConfiguration(
PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000
* metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full
* replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are
* erased.
*
*
* To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action.
* The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
* information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
* to Your Amazon S3 Resources.
*
*
* For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
* CloudWatch.
*
*
* The following operations are related to PutBucketMetricsConfiguration:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* PutBucketMetricsConfiguration has the following special error:
*
*
* -
*
* Error code: TooManyConfigurations
*
*
* -
*
* Description: You are attempting to create a new configuration but have already reached the 1,000-configuration
* limit.
*
*
* -
*
* HTTP Status Code: HTTP 400 Bad Request
*
*
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketMetricsConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketMetricsConfigurationRequest#builder()}
*
*
* @param putBucketMetricsConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketMetricsConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketMetricsConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketMetricsConfiguration
*/
default CompletableFuture putBucketMetricsConfiguration(
Consumer putBucketMetricsConfigurationRequest) {
return putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest.builder()
.applyMutation(putBucketMetricsConfigurationRequest).build());
}
/**
*
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event
* Notifications.
*
*
* Using this API, you can replace an existing notification configuration. The configuration is an XML file that
* defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to
* publish an event notification when it detects an event of the specified type.
*
*
* By default, your bucket has no event notifications configured. That is, the notification configuration will be an
* empty NotificationConfiguration.
*
*
* <NotificationConfiguration>
*
*
* </NotificationConfiguration>
*
*
* This action replaces the existing notification configuration with the configuration you include in the request
* body.
*
*
* After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS)
* or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to
* publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the
* Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more
* information, see Configuring
* Notifications for Amazon S3 Events.
*
*
* You can disable notifications by adding the empty NotificationConfiguration element.
*
*
* For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon
* Web Services General Reference.
*
*
* By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a
* bucket policy to grant permission to other users to set this configuration with the required
* s3:PutBucketNotification permission.
*
*
*
* The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS
* topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon
* S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3
* will not add the configuration to your bucket.
*
*
*
* If the configuration in the request body includes only one TopicConfiguration specifying only the
* s3:ReducedRedundancyLostObject event type, the response will also include the
* x-amz-sns-test-message-id header containing the message ID of the test notification sent to the
* topic.
*
*
* The following action is related to PutBucketNotificationConfiguration:
*
*
* -
*
*
*
*
* @param putBucketNotificationConfigurationRequest
* @return A Java Future containing the result of the PutBucketNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketNotificationConfiguration
*/
default CompletableFuture putBucketNotificationConfiguration(
PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event
* Notifications.
*
*
* Using this API, you can replace an existing notification configuration. The configuration is an XML file that
* defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to
* publish an event notification when it detects an event of the specified type.
*
*
* By default, your bucket has no event notifications configured. That is, the notification configuration will be an
* empty NotificationConfiguration.
*
*
* <NotificationConfiguration>
*
*
* </NotificationConfiguration>
*
*
* This action replaces the existing notification configuration with the configuration you include in the request
* body.
*
*
* After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS)
* or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to
* publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the
* Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more
* information, see Configuring
* Notifications for Amazon S3 Events.
*
*
* You can disable notifications by adding the empty NotificationConfiguration element.
*
*
* For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon
* Web Services General Reference.
*
*
* By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a
* bucket policy to grant permission to other users to set this configuration with the required
* s3:PutBucketNotification permission.
*
*
*
* The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS
* topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon
* S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3
* will not add the configuration to your bucket.
*
*
*
* If the configuration in the request body includes only one TopicConfiguration specifying only the
* s3:ReducedRedundancyLostObject event type, the response will also include the
* x-amz-sns-test-message-id header containing the message ID of the test notification sent to the
* topic.
*
*
* The following action is related to PutBucketNotificationConfiguration:
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketNotificationConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBucketNotificationConfigurationRequest#builder()}
*
*
* @param putBucketNotificationConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutBucketNotificationConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutBucketNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketNotificationConfiguration
*/
default CompletableFuture putBucketNotificationConfiguration(
Consumer putBucketNotificationConfigurationRequest) {
return putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest.builder()
.applyMutation(putBucketNotificationConfigurationRequest).build());
}
/**
*
* Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have
* the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see
* Specifying
* permissions in a policy.
*
*
* For information about Amazon S3 Object Ownership, see Using object
* ownership.
*
*
* The following operations are related to PutBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
* @param putBucketOwnershipControlsRequest
* @return A Java Future containing the result of the PutBucketOwnershipControls operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketOwnershipControls
*/
default CompletableFuture putBucketOwnershipControls(
PutBucketOwnershipControlsRequest putBucketOwnershipControlsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have
* the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see
* Specifying
* permissions in a policy.
*
*
* For information about Amazon S3 Object Ownership, see Using object
* ownership.
*
*
* The following operations are related to PutBucketOwnershipControls:
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketOwnershipControlsRequest.Builder} avoiding
* the need to create one manually via {@link PutBucketOwnershipControlsRequest#builder()}
*
*
* @param putBucketOwnershipControlsRequest
* A {@link Consumer} that will call methods on {@link PutBucketOwnershipControlsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutBucketOwnershipControls operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketOwnershipControls
*/
default CompletableFuture putBucketOwnershipControls(
Consumer putBucketOwnershipControlsRequest) {
return putBucketOwnershipControls(PutBucketOwnershipControlsRequest.builder()
.applyMutation(putBucketOwnershipControlsRequest).build());
}
/**
*
* Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user
* of the Amazon Web Services account that owns the bucket, the calling identity must have the
* PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in
* order to use this operation.
*
*
* If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* For more information, see Bucket policy
* examples.
*
*
* The following operations are related to PutBucketPolicy:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteBucket
*
*
*
*
* @param putBucketPolicyRequest
* @return A Java Future containing the result of the PutBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketPolicy
*/
default CompletableFuture putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user
* of the Amazon Web Services account that owns the bucket, the calling identity must have the
* PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in
* order to use this operation.
*
*
* If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
* error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
* account, Amazon S3 returns a 405 Method Not Allowed error.
*
*
*
* To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in
* a bucket owner's Amazon Web Services account can perform the GetBucketPolicy,
* PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy
* explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
*
*
*
* For more information, see Bucket policy
* examples.
*
*
* The following operations are related to PutBucketPolicy:
*
*
* -
*
* CreateBucket
*
*
* -
*
* DeleteBucket
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutBucketPolicyRequest.Builder} avoiding the need
* to create one manually via {@link PutBucketPolicyRequest#builder()}
*
*
* @param putBucketPolicyRequest
* A {@link Consumer} that will call methods on {@link PutBucketPolicyRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutBucketPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample S3AsyncClient.PutBucketPolicy
*/
default CompletableFuture putBucketPolicy(
Consumer putBucketPolicyRequest) {
return putBucketPolicy(PutBucketPolicyRequest.builder().applyMutation(putBucketPolicyRequest).build());
}
/**
*
* Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User
* Guide.
*
*
* Specify the replication configuration in the request body. In the replication configuration, you provide the name
* of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3
* can assume to replicate objects on your behalf, and other relevant information.
*
*
* A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule
* identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional
* subsets of objects to replicate, add a rule for each subset.
*
*
* To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as
* a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or
* both. When you add the Filter element in the configuration, you must also add the following elements:
* DeleteMarkerReplication, Status, and Priority.
*
*
*
* If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete
* markers differently. For more information, see