Package software.amazon.awssdk.services.s3control

Interface S3ControlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface S3ControlClient
extends AwsClient

Service client for accessing AWS S3 Control. This can be created using the static builder() method.

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static S3ControlClientBuilder	builder()	Create a builder that can be used to configure and create a S3ControlClient.
static S3ControlClient	create()	Create a S3ControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccessPointResponse	createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)	Creates an access point and associates it with the specified bucket.
default CreateAccessPointResponse	createAccessPoint(CreateAccessPointRequest createAccessPointRequest)	Creates an access point and associates it with the specified bucket.
default CreateAccessPointForObjectLambdaResponse	createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest)	Creates an Object Lambda Access Point.
default CreateAccessPointForObjectLambdaResponse	createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest)	Creates an Object Lambda Access Point.
default CreateBucketResponse	createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
default CreateBucketResponse	createBucket(CreateBucketRequest createBucketRequest)
default CreateJobResponse	createJob(Consumer<CreateJobRequest.Builder> createJobRequest)	You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
default CreateJobResponse	createJob(CreateJobRequest createJobRequest)	You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
default CreateMultiRegionAccessPointResponse	createMultiRegionAccessPoint(Consumer<CreateMultiRegionAccessPointRequest.Builder> createMultiRegionAccessPointRequest)	Creates a Multi-Region Access Point and associates it with the specified buckets.
default CreateMultiRegionAccessPointResponse	createMultiRegionAccessPoint(CreateMultiRegionAccessPointRequest createMultiRegionAccessPointRequest)	Creates a Multi-Region Access Point and associates it with the specified buckets.
default DeleteAccessPointResponse	deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)	Deletes the specified access point.
default DeleteAccessPointResponse	deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)	Deletes the specified access point.
default DeleteAccessPointForObjectLambdaResponse	deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest)	Deletes the specified Object Lambda Access Point.
default DeleteAccessPointForObjectLambdaResponse	deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest)	Deletes the specified Object Lambda Access Point.
default DeleteAccessPointPolicyResponse	deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)	Deletes the access point policy for the specified access point.
default DeleteAccessPointPolicyResponse	deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)	Deletes the access point policy for the specified access point.
default DeleteAccessPointPolicyForObjectLambdaResponse	deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest)	Removes the resource policy for an Object Lambda Access Point.
default DeleteAccessPointPolicyForObjectLambdaResponse	deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest)	Removes the resource policy for an Object Lambda Access Point.
default DeleteBucketResponse	deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
default DeleteBucketResponse	deleteBucket(DeleteBucketRequest deleteBucketRequest)
default DeleteBucketLifecycleConfigurationResponse	deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest)
default DeleteBucketLifecycleConfigurationResponse	deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)
default DeleteBucketPolicyResponse	deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
default DeleteBucketPolicyResponse	deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
default DeleteBucketReplicationResponse	deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
default DeleteBucketReplicationResponse	deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
default DeleteBucketTaggingResponse	deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
default DeleteBucketTaggingResponse	deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
default DeleteJobTaggingResponse	deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)	Removes the entire tag set from the specified S3 Batch Operations job.
default DeleteJobTaggingResponse	deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)	Removes the entire tag set from the specified S3 Batch Operations job.
default DeleteMultiRegionAccessPointResponse	deleteMultiRegionAccessPoint(Consumer<DeleteMultiRegionAccessPointRequest.Builder> deleteMultiRegionAccessPointRequest)	Deletes a Multi-Region Access Point.
default DeleteMultiRegionAccessPointResponse	deleteMultiRegionAccessPoint(DeleteMultiRegionAccessPointRequest deleteMultiRegionAccessPointRequest)	Deletes a Multi-Region Access Point.
default DeletePublicAccessBlockResponse	deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)	Removes the PublicAccessBlock configuration for an Amazon Web Services account.
default DeletePublicAccessBlockResponse	deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)	Removes the PublicAccessBlock configuration for an Amazon Web Services account.
default DeleteStorageLensConfigurationResponse	deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest)	Deletes the Amazon S3 Storage Lens configuration.
default DeleteStorageLensConfigurationResponse	deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest)	Deletes the Amazon S3 Storage Lens configuration.
default DeleteStorageLensConfigurationTaggingResponse	deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest)	Deletes the Amazon S3 Storage Lens configuration tags.
default DeleteStorageLensConfigurationTaggingResponse	deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest)	Deletes the Amazon S3 Storage Lens configuration tags.
default DescribeJobResponse	describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)	Retrieves the configuration parameters and status for a Batch Operations job.
default DescribeJobResponse	describeJob(DescribeJobRequest describeJobRequest)	Retrieves the configuration parameters and status for a Batch Operations job.
default DescribeMultiRegionAccessPointOperationResponse	describeMultiRegionAccessPointOperation(Consumer<DescribeMultiRegionAccessPointOperationRequest.Builder> describeMultiRegionAccessPointOperationRequest)	Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.
default DescribeMultiRegionAccessPointOperationResponse	describeMultiRegionAccessPointOperation(DescribeMultiRegionAccessPointOperationRequest describeMultiRegionAccessPointOperationRequest)	Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.
default GetAccessPointResponse	getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)	Returns configuration information about the specified access point.
default GetAccessPointResponse	getAccessPoint(GetAccessPointRequest getAccessPointRequest)	Returns configuration information about the specified access point.
default GetAccessPointConfigurationForObjectLambdaResponse	getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest)	Returns configuration for an Object Lambda Access Point.
default GetAccessPointConfigurationForObjectLambdaResponse	getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest)	Returns configuration for an Object Lambda Access Point.
default GetAccessPointForObjectLambdaResponse	getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest)	Returns configuration information about the specified Object Lambda Access Point
default GetAccessPointForObjectLambdaResponse	getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest)	Returns configuration information about the specified Object Lambda Access Point
default GetAccessPointPolicyResponse	getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)	Returns the access point policy associated with the specified access point.
default GetAccessPointPolicyResponse	getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)	Returns the access point policy associated with the specified access point.
default GetAccessPointPolicyForObjectLambdaResponse	getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest)	Returns the resource policy for an Object Lambda Access Point.
default GetAccessPointPolicyForObjectLambdaResponse	getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest)	Returns the resource policy for an Object Lambda Access Point.
default GetAccessPointPolicyStatusResponse	getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)	Indicates whether the specified access point currently has a policy that allows public access.
default GetAccessPointPolicyStatusResponse	getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)	Indicates whether the specified access point currently has a policy that allows public access.
default GetAccessPointPolicyStatusForObjectLambdaResponse	getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest)	Returns the status of the resource policy associated with an Object Lambda Access Point.
default GetAccessPointPolicyStatusForObjectLambdaResponse	getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest)	Returns the status of the resource policy associated with an Object Lambda Access Point.
default GetBucketResponse	getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest)	Gets an Amazon S3 on Outposts bucket.
default GetBucketResponse	getBucket(GetBucketRequest getBucketRequest)	Gets an Amazon S3 on Outposts bucket.
default GetBucketLifecycleConfigurationResponse	getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
default GetBucketLifecycleConfigurationResponse	getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
default GetBucketPolicyResponse	getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
default GetBucketPolicyResponse	getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
default GetBucketReplicationResponse	getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
default GetBucketReplicationResponse	getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
default GetBucketTaggingResponse	getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
default GetBucketTaggingResponse	getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
default GetBucketVersioningResponse	getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
default GetBucketVersioningResponse	getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
default GetJobTaggingResponse	getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)	Returns the tags on an S3 Batch Operations job.
default GetJobTaggingResponse	getJobTagging(GetJobTaggingRequest getJobTaggingRequest)	Returns the tags on an S3 Batch Operations job.
default GetMultiRegionAccessPointResponse	getMultiRegionAccessPoint(Consumer<GetMultiRegionAccessPointRequest.Builder> getMultiRegionAccessPointRequest)	Returns configuration information about the specified Multi-Region Access Point.
default GetMultiRegionAccessPointResponse	getMultiRegionAccessPoint(GetMultiRegionAccessPointRequest getMultiRegionAccessPointRequest)	Returns configuration information about the specified Multi-Region Access Point.
default GetMultiRegionAccessPointPolicyResponse	getMultiRegionAccessPointPolicy(Consumer<GetMultiRegionAccessPointPolicyRequest.Builder> getMultiRegionAccessPointPolicyRequest)	Returns the access control policy of the specified Multi-Region Access Point.
default GetMultiRegionAccessPointPolicyResponse	getMultiRegionAccessPointPolicy(GetMultiRegionAccessPointPolicyRequest getMultiRegionAccessPointPolicyRequest)	Returns the access control policy of the specified Multi-Region Access Point.
default GetMultiRegionAccessPointPolicyStatusResponse	getMultiRegionAccessPointPolicyStatus(Consumer<GetMultiRegionAccessPointPolicyStatusRequest.Builder> getMultiRegionAccessPointPolicyStatusRequest)	Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
default GetMultiRegionAccessPointPolicyStatusResponse	getMultiRegionAccessPointPolicyStatus(GetMultiRegionAccessPointPolicyStatusRequest getMultiRegionAccessPointPolicyStatusRequest)	Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
default GetMultiRegionAccessPointRoutesResponse	getMultiRegionAccessPointRoutes(Consumer<GetMultiRegionAccessPointRoutesRequest.Builder> getMultiRegionAccessPointRoutesRequest)	Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
default GetMultiRegionAccessPointRoutesResponse	getMultiRegionAccessPointRoutes(GetMultiRegionAccessPointRoutesRequest getMultiRegionAccessPointRoutesRequest)	Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
default GetPublicAccessBlockResponse	getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)	Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
default GetPublicAccessBlockResponse	getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)	Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
default GetStorageLensConfigurationResponse	getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest)	Gets the Amazon S3 Storage Lens configuration.
default GetStorageLensConfigurationResponse	getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest)	Gets the Amazon S3 Storage Lens configuration.
default GetStorageLensConfigurationTaggingResponse	getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest)	Gets the tags of Amazon S3 Storage Lens configuration.
default GetStorageLensConfigurationTaggingResponse	getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest)	Gets the tags of Amazon S3 Storage Lens configuration.
default ListAccessPointsResponse	listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)	Returns a list of the access points that are owned by the current account that's associated with the specified bucket.
default ListAccessPointsResponse	listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)	Returns a list of the access points that are owned by the current account that's associated with the specified bucket.
default ListAccessPointsForObjectLambdaResponse	listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)	Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
default ListAccessPointsForObjectLambdaResponse	listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)	Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
default ListAccessPointsForObjectLambdaIterable	listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)	Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
default ListAccessPointsForObjectLambdaIterable	listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)	Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
default ListAccessPointsIterable	listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)	Returns a list of the access points that are owned by the current account that's associated with the specified bucket.
default ListAccessPointsIterable	listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)	Returns a list of the access points that are owned by the current account that's associated with the specified bucket.
default ListJobsResponse	listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)	Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
default ListJobsResponse	listJobs(ListJobsRequest listJobsRequest)	Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
default ListJobsIterable	listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)	Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
default ListJobsIterable	listJobsPaginator(ListJobsRequest listJobsRequest)	Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
default ListMultiRegionAccessPointsResponse	listMultiRegionAccessPoints(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)	Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
default ListMultiRegionAccessPointsResponse	listMultiRegionAccessPoints(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)	Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
default ListMultiRegionAccessPointsIterable	listMultiRegionAccessPointsPaginator(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)	Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
default ListMultiRegionAccessPointsIterable	listMultiRegionAccessPointsPaginator(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)	Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
default ListRegionalBucketsResponse	listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)	Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
default ListRegionalBucketsResponse	listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest)	Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
default ListRegionalBucketsIterable	listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)	Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
default ListRegionalBucketsIterable	listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest)	Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
default ListStorageLensConfigurationsResponse	listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)	Gets a list of Amazon S3 Storage Lens configurations.
default ListStorageLensConfigurationsResponse	listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)	Gets a list of Amazon S3 Storage Lens configurations.
default ListStorageLensConfigurationsIterable	listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)	Gets a list of Amazon S3 Storage Lens configurations.
default ListStorageLensConfigurationsIterable	listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)	Gets a list of Amazon S3 Storage Lens configurations.
default PutAccessPointConfigurationForObjectLambdaResponse	putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest)	Replaces configuration for an Object Lambda Access Point.
default PutAccessPointConfigurationForObjectLambdaResponse	putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest)	Replaces configuration for an Object Lambda Access Point.
default PutAccessPointPolicyResponse	putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)	Associates an access policy with the specified access point.
default PutAccessPointPolicyResponse	putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)	Associates an access policy with the specified access point.
default PutAccessPointPolicyForObjectLambdaResponse	putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest)	Creates or replaces resource policy for an Object Lambda Access Point.
default PutAccessPointPolicyForObjectLambdaResponse	putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest)	Creates or replaces resource policy for an Object Lambda Access Point.
default PutBucketLifecycleConfigurationResponse	putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
default PutBucketLifecycleConfigurationResponse	putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
default PutBucketPolicyResponse	putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
default PutBucketPolicyResponse	putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
default PutBucketReplicationResponse	putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
default PutBucketReplicationResponse	putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
default PutBucketTaggingResponse	putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
default PutBucketTaggingResponse	putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
default PutBucketVersioningResponse	putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
default PutBucketVersioningResponse	putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
default PutJobTaggingResponse	putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)	Sets the supplied tag-set on an S3 Batch Operations job.
default PutJobTaggingResponse	putJobTagging(PutJobTaggingRequest putJobTaggingRequest)	Sets the supplied tag-set on an S3 Batch Operations job.
default PutMultiRegionAccessPointPolicyResponse	putMultiRegionAccessPointPolicy(Consumer<PutMultiRegionAccessPointPolicyRequest.Builder> putMultiRegionAccessPointPolicyRequest)	Associates an access control policy with the specified Multi-Region Access Point.
default PutMultiRegionAccessPointPolicyResponse	putMultiRegionAccessPointPolicy(PutMultiRegionAccessPointPolicyRequest putMultiRegionAccessPointPolicyRequest)	Associates an access control policy with the specified Multi-Region Access Point.
default PutPublicAccessBlockResponse	putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)	Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
default PutPublicAccessBlockResponse	putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)	Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
default PutStorageLensConfigurationResponse	putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest)	Puts an Amazon S3 Storage Lens configuration.
default PutStorageLensConfigurationResponse	putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest)	Puts an Amazon S3 Storage Lens configuration.
default PutStorageLensConfigurationTaggingResponse	putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest)	Put or replace tags on an existing Amazon S3 Storage Lens configuration.
default PutStorageLensConfigurationTaggingResponse	putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest)	Put or replace tags on an existing Amazon S3 Storage Lens configuration.
default S3ControlServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SubmitMultiRegionAccessPointRoutesResponse	submitMultiRegionAccessPointRoutes(Consumer<SubmitMultiRegionAccessPointRoutesRequest.Builder> submitMultiRegionAccessPointRoutesRequest)	Submits an updated route configuration for a Multi-Region Access Point.
default SubmitMultiRegionAccessPointRoutesResponse	submitMultiRegionAccessPointRoutes(SubmitMultiRegionAccessPointRoutesRequest submitMultiRegionAccessPointRoutesRequest)	Submits an updated route configuration for a Multi-Region Access Point.
default UpdateJobPriorityResponse	updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)	Updates an existing S3 Batch Operations job's priority.
default UpdateJobPriorityResponse	updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)	Updates an existing S3 Batch Operations job's priority.
default UpdateJobStatusResponse	updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)	Updates the status for the specified job.
default UpdateJobStatusResponse	updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)	Updates the status for the specified job.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createAccessPoint

default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

• GetAccessPoint

• DeleteAccessPoint

• ListAccessPoints

Parameters:

createAccessPointRequest -

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createAccessPoint

default CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

• GetAccessPoint

• DeleteAccessPoint

• ListAccessPoints

This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need to create one manually via CreateAccessPointRequest.builder()

Parameters:

createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.

Returns:

Result of the CreateAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createAccessPointForObjectLambda

default CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest)
                                                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

Parameters:

createAccessPointForObjectLambdaRequest -

Returns:

Result of the CreateAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

createAccessPointForObjectLambda

default CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest)
                                                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

This is a convenience which creates an instance of the CreateAccessPointForObjectLambdaRequest.Builder avoiding the need to create one manually via CreateAccessPointForObjectLambdaRequest.builder()

Parameters:

createAccessPointForObjectLambdaRequest - A Consumer that will call methods on CreateAccessPointForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the CreateAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

createBucket

default CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest)
                                   throws BucketAlreadyExistsException,
BucketAlreadyOwnedByYouException,
AwsServiceException,
SdkClientException,
S3ControlException

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

• Tags

• LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

• PutObject

• GetBucket

• DeleteBucket

• CreateAccessPoint

• PutAccessPointPolicy

Parameters:

createBucketRequest -

Returns:

Result of the CreateBucket operation returned by the service.

See Also:

• AWS API Documentation

createBucket

default CreateBucketResponse createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
                                   throws BucketAlreadyExistsException,
BucketAlreadyOwnedByYouException,
AwsServiceException,
SdkClientException,
S3ControlException

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

• Tags

• LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

• PutObject

• GetBucket

• DeleteBucket

• CreateAccessPoint

• PutAccessPointPolicy

This is a convenience which creates an instance of the CreateBucketRequest.Builder avoiding the need to create one manually via CreateBucketRequest.builder()

Parameters:

createBucketRequest - A Consumer that will call methods on CreateBucketRequest.Builder to create a request.

Returns:

Result of the CreateBucket operation returned by the service.

See Also:

• AWS API Documentation

createJob

default CreateJobResponse createJob(CreateJobRequest createJobRequest)
                             throws TooManyRequestsException,
BadRequestException,
IdempotencyException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

• DescribeJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

• JobOperation

Parameters:

createJobRequest -

Returns:

Result of the CreateJob operation returned by the service.

See Also:

• AWS API Documentation

createJob

default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
                             throws TooManyRequestsException,
BadRequestException,
IdempotencyException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

• DescribeJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

• JobOperation

This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to create one manually via CreateJobRequest.builder()

Parameters:

createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.

Returns:

Result of the CreateJob operation returned by the service.

See Also:

• AWS API Documentation

createMultiRegionAccessPoint

default CreateMultiRegionAccessPointResponse createMultiRegionAccessPoint(CreateMultiRegionAccessPointRequest createMultiRegionAccessPointRequest)
                                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to CreateMultiRegionAccessPoint:

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

Parameters:

createMultiRegionAccessPointRequest -

Returns:

Result of the CreateMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

createMultiRegionAccessPoint

default CreateMultiRegionAccessPointResponse createMultiRegionAccessPoint(Consumer<CreateMultiRegionAccessPointRequest.Builder> createMultiRegionAccessPointRequest)
                                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to CreateMultiRegionAccessPoint:

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

This is a convenience which creates an instance of the CreateMultiRegionAccessPointRequest.Builder avoiding the need to create one manually via CreateMultiRegionAccessPointRequest.builder()

Parameters:

createMultiRegionAccessPointRequest - A Consumer that will call methods on CreateMultiRegionAccessPointRequest.Builder to create a request.

Returns:

Result of the CreateMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

• CreateAccessPoint

• GetAccessPoint

• ListAccessPoints

Parameters:

deleteAccessPointRequest -

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPoint

default DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

• CreateAccessPoint

• GetAccessPoint

• ListAccessPoints

This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need to create one manually via DeleteAccessPointRequest.builder()

Parameters:

deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointForObjectLambda

default DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest)
                                                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

Parameters:

deleteAccessPointForObjectLambdaRequest -

Returns:

Result of the DeleteAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointForObjectLambda

default DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest)
                                                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

This is a convenience which creates an instance of the DeleteAccessPointForObjectLambdaRequest.Builder avoiding the need to create one manually via DeleteAccessPointForObjectLambdaRequest.builder()

Parameters:

deleteAccessPointForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointPolicy

default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

• PutAccessPointPolicy

• GetAccessPointPolicy

Parameters:

deleteAccessPointPolicyRequest -

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointPolicy

default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

• PutAccessPointPolicy

• GetAccessPointPolicy

This is a convenience which creates an instance of the DeleteAccessPointPolicyRequest.Builder avoiding the need to create one manually via DeleteAccessPointPolicyRequest.builder()

Parameters:

deleteAccessPointPolicyRequest - A Consumer that will call methods on DeleteAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointPolicyForObjectLambda

default DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest)
                                                                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

• GetAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

Parameters:

deleteAccessPointPolicyForObjectLambdaRequest -

Returns:

Result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPointPolicyForObjectLambda

default DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest)
                                                                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

• GetAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

This is a convenience which creates an instance of the DeleteAccessPointPolicyForObjectLambdaRequest.Builder avoiding the need to create one manually via DeleteAccessPointPolicyForObjectLambdaRequest.builder()

Parameters:

deleteAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointPolicyForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

deleteBucket

default DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest)
                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

Related Resources

• CreateBucket

• GetBucket

• DeleteObject

Parameters:

deleteBucketRequest -

Returns:

Result of the DeleteBucket operation returned by the service.

See Also:

• AWS API Documentation

deleteBucket

default DeleteBucketResponse deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

Related Resources

• CreateBucket

• GetBucket

• DeleteObject

This is a convenience which creates an instance of the DeleteBucketRequest.Builder avoiding the need to create one manually via DeleteBucketRequest.builder()

Parameters:

deleteBucketRequest - A Consumer that will call methods on DeleteBucketRequest.Builder to create a request.

Returns:

Result of the DeleteBucket operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketLifecycleConfiguration

default DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Parameters:

deleteBucketLifecycleConfigurationRequest -

Returns:

Result of the DeleteBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketLifecycleConfiguration

default DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

This is a convenience which creates an instance of the DeleteBucketLifecycleConfigurationRequest.Builder avoiding the need to create one manually via DeleteBucketLifecycleConfigurationRequest.builder()

Parameters:

deleteBucketLifecycleConfigurationRequest - A Consumer that will call methods on DeleteBucketLifecycleConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketPolicy

default DeleteBucketPolicyResponse deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
                                               throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts 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 s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

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.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

• GetBucketPolicy

• PutBucketPolicy

Parameters:

deleteBucketPolicyRequest -

Returns:

Result of the DeleteBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketPolicy

default DeleteBucketPolicyResponse deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
                                               throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts 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 s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

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.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

• GetBucketPolicy

• PutBucketPolicy

This is a convenience which creates an instance of the DeleteBucketPolicyRequest.Builder avoiding the need to create one manually via DeleteBucketPolicyRequest.builder()

Parameters:

deleteBucketPolicyRequest - A Consumer that will call methods on DeleteBucketPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketReplication

default DeleteBucketReplicationResponse deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

Deletes the replication configuration from the specified S3 on Outposts bucket.

To use this operation, you must have permissions to perform the s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

• PutBucketReplication

• GetBucketReplication

Parameters:

deleteBucketReplicationRequest -

Returns:

Result of the DeleteBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketReplication

default DeleteBucketReplicationResponse deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

Deletes the replication configuration from the specified S3 on Outposts bucket.

To use this operation, you must have permissions to perform the s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

• PutBucketReplication

• GetBucketReplication

This is a convenience which creates an instance of the DeleteBucketReplicationRequest.Builder avoiding the need to create one manually via DeleteBucketReplicationRequest.builder()

Parameters:

deleteBucketReplicationRequest - A Consumer that will call methods on DeleteBucketReplicationRequest.Builder to create a request.

Returns:

Result of the DeleteBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketTagging

default DeleteBucketTaggingResponse deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

• GetBucketTagging

• PutBucketTagging

Parameters:

deleteBucketTaggingRequest -

Returns:

Result of the DeleteBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

deleteBucketTagging

default DeleteBucketTaggingResponse deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

• GetBucketTagging

• PutBucketTagging

This is a convenience which creates an instance of the DeleteBucketTaggingRequest.Builder avoiding the need to create one manually via DeleteBucketTaggingRequest.builder()

Parameters:

deleteBucketTaggingRequest - A Consumer that will call methods on DeleteBucketTaggingRequest.Builder to create a request.

Returns:

Result of the DeleteBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

deleteJobTagging

default DeleteJobTaggingResponse deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
                                           throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3ControlException

Removes the entire tag set from the specified S3 Batch Operations job. To use the DeleteJobTagging operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• GetJobTagging

• PutJobTagging

Parameters:

deleteJobTaggingRequest -

Returns:

Result of the DeleteJobTagging operation returned by the service.

See Also:

• AWS API Documentation

deleteJobTagging

default DeleteJobTaggingResponse deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)
                                           throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3ControlException

Removes the entire tag set from the specified S3 Batch Operations job. To use the DeleteJobTagging operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• GetJobTagging

• PutJobTagging

This is a convenience which creates an instance of the DeleteJobTaggingRequest.Builder avoiding the need to create one manually via DeleteJobTaggingRequest.builder()

Parameters:

deleteJobTaggingRequest - A Consumer that will call methods on DeleteJobTaggingRequest.Builder to create a request.

Returns:

Result of the DeleteJobTagging operation returned by the service.

See Also:

• AWS API Documentation

deleteMultiRegionAccessPoint

default DeleteMultiRegionAccessPointResponse deleteMultiRegionAccessPoint(DeleteMultiRegionAccessPointRequest deleteMultiRegionAccessPointRequest)
                                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to DeleteMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

Parameters:

deleteMultiRegionAccessPointRequest -

Returns:

Result of the DeleteMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deleteMultiRegionAccessPoint

default DeleteMultiRegionAccessPointResponse deleteMultiRegionAccessPoint(Consumer<DeleteMultiRegionAccessPointRequest.Builder> deleteMultiRegionAccessPointRequest)
                                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to DeleteMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

This is a convenience which creates an instance of the DeleteMultiRegionAccessPointRequest.Builder avoiding the need to create one manually via DeleteMultiRegionAccessPointRequest.builder()

Parameters:

deleteMultiRegionAccessPointRequest - A Consumer that will call methods on DeleteMultiRegionAccessPointRequest.Builder to create a request.

Returns:

Result of the DeleteMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

deletePublicAccessBlock

default DeletePublicAccessBlockResponse deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• GetPublicAccessBlock

• PutPublicAccessBlock

Parameters:

deletePublicAccessBlockRequest -

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

deletePublicAccessBlock

default DeletePublicAccessBlockResponse deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• GetPublicAccessBlock

• PutPublicAccessBlock

This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder avoiding the need to create one manually via DeletePublicAccessBlockRequest.builder()

Parameters:

deletePublicAccessBlockRequest - A Consumer that will call methods on DeletePublicAccessBlockRequest.Builder to create a request.

Returns:

Result of the DeletePublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

deleteStorageLensConfiguration

default DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest)
                                                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

deleteStorageLensConfigurationRequest -

Returns:

Result of the DeleteStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteStorageLensConfiguration

default DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest)
                                                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the DeleteStorageLensConfigurationRequest.Builder avoiding the need to create one manually via DeleteStorageLensConfigurationRequest.builder()

Parameters:

deleteStorageLensConfigurationRequest - A Consumer that will call methods on DeleteStorageLensConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteStorageLensConfigurationTagging

default DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest)
                                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

deleteStorageLensConfigurationTaggingRequest -

Returns:

Result of the DeleteStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

deleteStorageLensConfigurationTagging

default DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest)
                                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the DeleteStorageLensConfigurationTaggingRequest.Builder avoiding the need to create one manually via DeleteStorageLensConfigurationTaggingRequest.builder()

Parameters:

deleteStorageLensConfigurationTaggingRequest - A Consumer that will call methods on DeleteStorageLensConfigurationTaggingRequest.Builder to create a request.

Returns:

Result of the DeleteStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

describeJob

default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest)
                                 throws BadRequestException,
TooManyRequestsException,
NotFoundException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

Parameters:

describeJobRequest -

Returns:

Result of the DescribeJob operation returned by the service.

See Also:

• AWS API Documentation

describeJob

default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
                                 throws BadRequestException,
TooManyRequestsException,
NotFoundException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

This is a convenience which creates an instance of the DescribeJobRequest.Builder avoiding the need to create one manually via DescribeJobRequest.builder()

Parameters:

describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.

Returns:

Result of the DescribeJob operation returned by the service.

See Also:

• AWS API Documentation

describeMultiRegionAccessPointOperation

default DescribeMultiRegionAccessPointOperationResponse describeMultiRegionAccessPointOperation(DescribeMultiRegionAccessPointOperationRequest describeMultiRegionAccessPointOperationRequest)
                                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

Parameters:

describeMultiRegionAccessPointOperationRequest -

Returns:

Result of the DescribeMultiRegionAccessPointOperation operation returned by the service.

See Also:

• AWS API Documentation

describeMultiRegionAccessPointOperation

default DescribeMultiRegionAccessPointOperationResponse describeMultiRegionAccessPointOperation(Consumer<DescribeMultiRegionAccessPointOperationRequest.Builder> describeMultiRegionAccessPointOperationRequest)
                                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

This is a convenience which creates an instance of the DescribeMultiRegionAccessPointOperationRequest.Builder avoiding the need to create one manually via DescribeMultiRegionAccessPointOperationRequest.builder()

Parameters:

describeMultiRegionAccessPointOperationRequest - A Consumer that will call methods on DescribeMultiRegionAccessPointOperationRequest.Builder to create a request.

Returns:

Result of the DescribeMultiRegionAccessPointOperation operation returned by the service.

See Also:

• AWS API Documentation

getAccessPoint

default GetAccessPointResponse getAccessPoint(GetAccessPointRequest getAccessPointRequest)
                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

• CreateAccessPoint

• DeleteAccessPoint

• ListAccessPoints

Parameters:

getAccessPointRequest -

Returns:

Result of the GetAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

getAccessPoint

default GetAccessPointResponse getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)
                                       throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

• CreateAccessPoint

• DeleteAccessPoint

• ListAccessPoints

This is a convenience which creates an instance of the GetAccessPointRequest.Builder avoiding the need to create one manually via GetAccessPointRequest.builder()

Parameters:

getAccessPointRequest - A Consumer that will call methods on GetAccessPointRequest.Builder to create a request.

Returns:

Result of the GetAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointConfigurationForObjectLambda

default GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest)
                                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

• PutAccessPointConfigurationForObjectLambda

Parameters:

getAccessPointConfigurationForObjectLambdaRequest -

Returns:

Result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointConfigurationForObjectLambda

default GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest)
                                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

• PutAccessPointConfigurationForObjectLambda

This is a convenience which creates an instance of the GetAccessPointConfigurationForObjectLambdaRequest.Builder avoiding the need to create one manually via GetAccessPointConfigurationForObjectLambdaRequest.builder()

Parameters:

getAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointForObjectLambda

default GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest)
                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

Parameters:

getAccessPointForObjectLambdaRequest -

Returns:

Result of the GetAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointForObjectLambda

default GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest)
                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

This is a convenience which creates an instance of the GetAccessPointForObjectLambdaRequest.Builder avoiding the need to create one manually via GetAccessPointForObjectLambdaRequest.builder()

Parameters:

getAccessPointForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the GetAccessPointForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicy

default GetAccessPointPolicyResponse getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the access point policy associated with the specified access point.

The following actions are related to GetAccessPointPolicy:

• PutAccessPointPolicy

• DeleteAccessPointPolicy

Parameters:

getAccessPointPolicyRequest -

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicy

default GetAccessPointPolicyResponse getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the access point policy associated with the specified access point.

The following actions are related to GetAccessPointPolicy:

• PutAccessPointPolicy

• DeleteAccessPointPolicy

This is a convenience which creates an instance of the GetAccessPointPolicyRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyRequest.builder()

Parameters:

getAccessPointPolicyRequest - A Consumer that will call methods on GetAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyForObjectLambda

default GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest)
                                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

• DeleteAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

Parameters:

getAccessPointPolicyForObjectLambdaRequest -

Returns:

Result of the GetAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyForObjectLambda

default GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest)
                                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

• DeleteAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

This is a convenience which creates an instance of the GetAccessPointPolicyForObjectLambdaRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyForObjectLambdaRequest.builder()

Parameters:

getAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointPolicyForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyStatus

default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.

Parameters:

getAccessPointPolicyStatusRequest -

Returns:

Result of the GetAccessPointPolicyStatus operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyStatus

default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)
                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.

This is a convenience which creates an instance of the GetAccessPointPolicyStatusRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyStatusRequest.builder()

Parameters:

getAccessPointPolicyStatusRequest - A Consumer that will call methods on GetAccessPointPolicyStatusRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicyStatus operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyStatusForObjectLambda

default GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest)
                                                                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the status of the resource policy associated with an Object Lambda Access Point.

Parameters:

getAccessPointPolicyStatusForObjectLambdaRequest -

Returns:

Result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getAccessPointPolicyStatusForObjectLambda

default GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest)
                                                                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the status of the resource policy associated with an Object Lambda Access Point.

This is a convenience which creates an instance of the GetAccessPointPolicyStatusForObjectLambdaRequest.Builder avoiding the need to create one manually via GetAccessPointPolicyStatusForObjectLambdaRequest.builder()

Parameters:

getAccessPointPolicyStatusForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointPolicyStatusForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

getBucket

default GetBucketResponse getBucket(GetBucketRequest getBucketRequest)
                             throws AwsServiceException,
SdkClientException,
S3ControlException

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

The following actions are related to GetBucket for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

• PutObject

• CreateBucket

• DeleteBucket

Parameters:

getBucketRequest -

Returns:

Result of the GetBucket operation returned by the service.

See Also:

• AWS API Documentation

getBucket

default GetBucketResponse getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest)
                             throws AwsServiceException,
SdkClientException,
S3ControlException

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

The following actions are related to GetBucket for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

• PutObject

• CreateBucket

• DeleteBucket

This is a convenience which creates an instance of the GetBucketRequest.Builder avoiding the need to create one manually via GetBucketRequest.builder()

Parameters:

getBucketRequest - A Consumer that will call methods on GetBucketRequest.Builder to create a request.

Returns:

Result of the GetBucket operation returned by the service.

See Also:

• AWS API Documentation

getBucketLifecycleConfiguration

default GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts 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.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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 actions are related to GetBucketLifecycleConfiguration:

• PutBucketLifecycleConfiguration

• DeleteBucketLifecycleConfiguration

Parameters:

getBucketLifecycleConfigurationRequest -

Returns:

Result of the GetBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getBucketLifecycleConfiguration

default GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts 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.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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 actions are related to GetBucketLifecycleConfiguration:

• PutBucketLifecycleConfiguration

• DeleteBucketLifecycleConfiguration

This is a convenience which creates an instance of the GetBucketLifecycleConfigurationRequest.Builder avoiding the need to create one manually via GetBucketLifecycleConfigurationRequest.builder()

Parameters:

getBucketLifecycleConfigurationRequest - A Consumer that will call methods on GetBucketLifecycleConfigurationRequest.Builder to create a request.

Returns:

Result of the GetBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getBucketPolicy

default GetBucketPolicyResponse getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

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 action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

• GetObject

• PutBucketPolicy

• DeleteBucketPolicy

Parameters:

getBucketPolicyRequest -

Returns:

Result of the GetBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

getBucketPolicy

default GetBucketPolicyResponse getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

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 action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

• GetObject

• PutBucketPolicy

• DeleteBucketPolicy

This is a convenience which creates an instance of the GetBucketPolicyRequest.Builder avoiding the need to create one manually via GetBucketPolicyRequest.builder()

Parameters:

getBucketPolicyRequest - A Consumer that will call methods on GetBucketPolicyRequest.Builder to create a request.

Returns:

Result of the GetBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

getBucketReplication

default GetBucketReplicationResponse getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.

Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

This action requires permissions for the s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication, Status, and Priority elements. The response also returns those elements.

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

The following operations are related to GetBucketReplication:

• PutBucketReplication

• DeleteBucketReplication

Parameters:

getBucketReplicationRequest -

Returns:

Result of the GetBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

getBucketReplication

default GetBucketReplicationResponse getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.

Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

This action requires permissions for the s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication, Status, and Priority elements. The response also returns those elements.

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

The following operations are related to GetBucketReplication:

• PutBucketReplication

• DeleteBucketReplication

This is a convenience which creates an instance of the GetBucketReplicationRequest.Builder avoiding the need to create one manually via GetBucketReplicationRequest.builder()

Parameters:

getBucketReplicationRequest - A Consumer that will call methods on GetBucketReplicationRequest.Builder to create a request.

Returns:

Result of the GetBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

getBucketTagging

default GetBucketTaggingResponse getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, you must have permission to perform the 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: NoSuchTagSetError

  • Description: There is no tag set associated with the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

• PutBucketTagging

• DeleteBucketTagging

Parameters:

getBucketTaggingRequest -

Returns:

Result of the GetBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

getBucketTagging

default GetBucketTaggingResponse getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, you must have permission to perform the 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: NoSuchTagSetError

  • Description: There is no tag set associated with the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

• PutBucketTagging

• DeleteBucketTagging

This is a convenience which creates an instance of the GetBucketTaggingRequest.Builder avoiding the need to create one manually via GetBucketTaggingRequest.builder()

Parameters:

getBucketTaggingRequest - A Consumer that will call methods on GetBucketTaggingRequest.Builder to create a request.

Returns:

Result of the GetBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

getBucketVersioning

default GetBucketVersioningResponse getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.

Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value.

For more information about versioning, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to GetBucketVersioning for S3 on Outposts.

• PutBucketVersioning

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Parameters:

getBucketVersioningRequest -

Returns:

Result of the GetBucketVersioning operation returned by the service.

See Also:

• AWS API Documentation

getBucketVersioning

default GetBucketVersioningResponse getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.

Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value.

For more information about versioning, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to GetBucketVersioning for S3 on Outposts.

• PutBucketVersioning

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

This is a convenience which creates an instance of the GetBucketVersioningRequest.Builder avoiding the need to create one manually via GetBucketVersioningRequest.builder()

Parameters:

getBucketVersioningRequest - A Consumer that will call methods on GetBucketVersioningRequest.Builder to create a request.

Returns:

Result of the GetBucketVersioning operation returned by the service.

See Also:

• AWS API Documentation

getJobTagging

default GetJobTaggingResponse getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
                                     throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3ControlException

Returns the tags on an S3 Batch Operations job. To use the GetJobTagging operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• PutJobTagging

• DeleteJobTagging

Parameters:

getJobTaggingRequest -

Returns:

Result of the GetJobTagging operation returned by the service.

See Also:

• AWS API Documentation

getJobTagging

default GetJobTaggingResponse getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)
                                     throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3ControlException

Returns the tags on an S3 Batch Operations job. To use the GetJobTagging operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• PutJobTagging

• DeleteJobTagging

This is a convenience which creates an instance of the GetJobTaggingRequest.Builder avoiding the need to create one manually via GetJobTaggingRequest.builder()

Parameters:

getJobTaggingRequest - A Consumer that will call methods on GetJobTaggingRequest.Builder to create a request.

Returns:

Result of the GetJobTagging operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPoint

default GetMultiRegionAccessPointResponse getMultiRegionAccessPoint(GetMultiRegionAccessPointRequest getMultiRegionAccessPointRequest)
                                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• ListMultiRegionAccessPoints

Parameters:

getMultiRegionAccessPointRequest -

Returns:

Result of the GetMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPoint

default GetMultiRegionAccessPointResponse getMultiRegionAccessPoint(Consumer<GetMultiRegionAccessPointRequest.Builder> getMultiRegionAccessPointRequest)
                                                             throws AwsServiceException,
SdkClientException,
S3ControlException

Returns configuration information about the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• ListMultiRegionAccessPoints

This is a convenience which creates an instance of the GetMultiRegionAccessPointRequest.Builder avoiding the need to create one manually via GetMultiRegionAccessPointRequest.builder()

Parameters:

getMultiRegionAccessPointRequest - A Consumer that will call methods on GetMultiRegionAccessPointRequest.Builder to create a request.

Returns:

Result of the GetMultiRegionAccessPoint operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointPolicy

default GetMultiRegionAccessPointPolicyResponse getMultiRegionAccessPointPolicy(GetMultiRegionAccessPointPolicyRequest getMultiRegionAccessPointPolicyRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the access control policy of the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicy:

• GetMultiRegionAccessPointPolicyStatus

• PutMultiRegionAccessPointPolicy

Parameters:

getMultiRegionAccessPointPolicyRequest -

Returns:

Result of the GetMultiRegionAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointPolicy

default GetMultiRegionAccessPointPolicyResponse getMultiRegionAccessPointPolicy(Consumer<GetMultiRegionAccessPointPolicyRequest.Builder> getMultiRegionAccessPointPolicyRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the access control policy of the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicy:

• GetMultiRegionAccessPointPolicyStatus

• PutMultiRegionAccessPointPolicy

This is a convenience which creates an instance of the GetMultiRegionAccessPointPolicyRequest.Builder avoiding the need to create one manually via GetMultiRegionAccessPointPolicyRequest.builder()

Parameters:

getMultiRegionAccessPointPolicyRequest - A Consumer that will call methods on GetMultiRegionAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the GetMultiRegionAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointPolicyStatus

default GetMultiRegionAccessPointPolicyStatusResponse getMultiRegionAccessPointPolicyStatus(GetMultiRegionAccessPointPolicyStatusRequest getMultiRegionAccessPointPolicyStatusRequest)
                                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

• GetMultiRegionAccessPointPolicy

• PutMultiRegionAccessPointPolicy

Parameters:

getMultiRegionAccessPointPolicyStatusRequest -

Returns:

Result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointPolicyStatus

default GetMultiRegionAccessPointPolicyStatusResponse getMultiRegionAccessPointPolicyStatus(Consumer<GetMultiRegionAccessPointPolicyStatusRequest.Builder> getMultiRegionAccessPointPolicyStatusRequest)
                                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

• GetMultiRegionAccessPointPolicy

• PutMultiRegionAccessPointPolicy

This is a convenience which creates an instance of the GetMultiRegionAccessPointPolicyStatusRequest.Builder avoiding the need to create one manually via GetMultiRegionAccessPointPolicyStatusRequest.builder()

Parameters:

getMultiRegionAccessPointPolicyStatusRequest - A Consumer that will call methods on GetMultiRegionAccessPointPolicyStatusRequest.Builder to create a request.

Returns:

Result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointRoutes

default GetMultiRegionAccessPointRoutesResponse getMultiRegionAccessPointRoutes(GetMultiRegionAccessPointRoutesRequest getMultiRegionAccessPointRoutesRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

• us-east-1

• us-west-2

• ap-southeast-2

• ap-northeast-1

• eu-west-1

Your Amazon S3 bucket does not need to be in these five Regions.

Parameters:

getMultiRegionAccessPointRoutesRequest -

Returns:

Result of the GetMultiRegionAccessPointRoutes operation returned by the service.

See Also:

• AWS API Documentation

getMultiRegionAccessPointRoutes

default GetMultiRegionAccessPointRoutesResponse getMultiRegionAccessPointRoutes(Consumer<GetMultiRegionAccessPointRoutesRequest.Builder> getMultiRegionAccessPointRoutesRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

• us-east-1

• us-west-2

• ap-southeast-2

• ap-northeast-1

• eu-west-1

Your Amazon S3 bucket does not need to be in these five Regions.

This is a convenience which creates an instance of the GetMultiRegionAccessPointRoutesRequest.Builder avoiding the need to create one manually via GetMultiRegionAccessPointRoutesRequest.builder()

Parameters:

getMultiRegionAccessPointRoutesRequest - A Consumer that will call methods on GetMultiRegionAccessPointRoutesRequest.Builder to create a request.

Returns:

Result of the GetMultiRegionAccessPointRoutes operation returned by the service.

See Also:

• AWS API Documentation

getPublicAccessBlock

default GetPublicAccessBlockResponse getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
                                                   throws NoSuchPublicAccessBlockConfigurationException,
AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• DeletePublicAccessBlock

• PutPublicAccessBlock

Parameters:

getPublicAccessBlockRequest -

Returns:

Result of the GetPublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

getPublicAccessBlock

default GetPublicAccessBlockResponse getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
                                                   throws NoSuchPublicAccessBlockConfigurationException,
AwsServiceException,
SdkClientException,
S3ControlException

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• DeletePublicAccessBlock

• PutPublicAccessBlock

This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder avoiding the need to create one manually via GetPublicAccessBlockRequest.builder()

Parameters:

getPublicAccessBlockRequest - A Consumer that will call methods on GetPublicAccessBlockRequest.Builder to create a request.

Returns:

Result of the GetPublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

getStorageLensConfiguration

default GetStorageLensConfigurationResponse getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

getStorageLensConfigurationRequest -

Returns:

Result of the GetStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getStorageLensConfiguration

default GetStorageLensConfigurationResponse getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the GetStorageLensConfigurationRequest.Builder avoiding the need to create one manually via GetStorageLensConfigurationRequest.builder()

Parameters:

getStorageLensConfigurationRequest - A Consumer that will call methods on GetStorageLensConfigurationRequest.Builder to create a request.

Returns:

Result of the GetStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getStorageLensConfigurationTagging

default GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

getStorageLensConfigurationTaggingRequest -

Returns:

Result of the GetStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

getStorageLensConfigurationTagging

default GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the GetStorageLensConfigurationTaggingRequest.Builder avoiding the need to create one manually via GetStorageLensConfigurationTaggingRequest.builder()

Parameters:

getStorageLensConfigurationTaggingRequest - A Consumer that will call methods on GetStorageLensConfigurationTaggingRequest.Builder to create a request.

Returns:

Result of the GetStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

listAccessPoints

default ListAccessPointsResponse listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

• CreateAccessPoint

• DeleteAccessPoint

• GetAccessPoint

Parameters:

listAccessPointsRequest -

Returns:

Result of the ListAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

listAccessPoints

default ListAccessPointsResponse listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

• CreateAccessPoint

• DeleteAccessPoint

• GetAccessPoint

This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need to create one manually via ListAccessPointsRequest.builder()

Parameters:

listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.

Returns:

Result of the ListAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

listAccessPointsPaginator

default ListAccessPointsIterable listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)
                                                    throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

• CreateAccessPoint

• DeleteAccessPoint

• GetAccessPoint

This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
             .listAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.

Parameters:

listAccessPointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPointsPaginator

default ListAccessPointsIterable listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
                                                    throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

• CreateAccessPoint

• DeleteAccessPoint

• GetAccessPoint

This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
             .listAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.

This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need to create one manually via ListAccessPointsRequest.builder()

Parameters:

listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPointsForObjectLambda

default ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

Parameters:

listAccessPointsForObjectLambdaRequest -

Returns:

Result of the ListAccessPointsForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

listAccessPointsForObjectLambda

default ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

This is a convenience which creates an instance of the ListAccessPointsForObjectLambdaRequest.Builder avoiding the need to create one manually via ListAccessPointsForObjectLambdaRequest.builder()

Parameters:

listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the ListAccessPointsForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

listAccessPointsForObjectLambdaPaginator

default ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)
                                                                                  throws AwsServiceException,
SdkClientException,
S3ControlException

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

This is a variant of listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client
             .listAccessPointsForObjectLambdaPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation.

Parameters:

listAccessPointsForObjectLambdaRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPointsForObjectLambdaPaginator

default ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)
                                                                                  throws AwsServiceException,
SdkClientException,
S3ControlException

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

This is a variant of listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client
             .listAccessPointsForObjectLambdaPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation.

This is a convenience which creates an instance of the ListAccessPointsForObjectLambdaRequest.Builder avoiding the need to create one manually via ListAccessPointsForObjectLambdaRequest.builder()

Parameters:

listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listJobs

default ListJobsResponse listJobs(ListJobsRequest listJobsRequest)
                           throws InvalidRequestException,
InternalServiceException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
S3ControlException

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• DescribeJob

• UpdateJobPriority

• UpdateJobStatus

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

See Also:

• AWS API Documentation

listJobs

default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
                           throws InvalidRequestException,
InternalServiceException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
S3ControlException

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• DescribeJob

• UpdateJobPriority

• UpdateJobStatus

This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.

Returns:

Result of the ListJobs operation returned by the service.

See Also:

• AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest)
                                    throws InvalidRequestException,
InternalServiceException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
S3ControlException

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• DescribeJob

• UpdateJobPriority

• UpdateJobStatus

This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.

Parameters:

listJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
                                    throws InvalidRequestException,
InternalServiceException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
S3ControlException

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• DescribeJob

• UpdateJobPriority

• UpdateJobStatus

This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.

This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMultiRegionAccessPoints

default ListMultiRegionAccessPointsResponse listMultiRegionAccessPoints(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

Parameters:

listMultiRegionAccessPointsRequest -

Returns:

Result of the ListMultiRegionAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

listMultiRegionAccessPoints

default ListMultiRegionAccessPointsResponse listMultiRegionAccessPoints(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

This is a convenience which creates an instance of the ListMultiRegionAccessPointsRequest.Builder avoiding the need to create one manually via ListMultiRegionAccessPointsRequest.builder()

Parameters:

listMultiRegionAccessPointsRequest - A Consumer that will call methods on ListMultiRegionAccessPointsRequest.Builder to create a request.

Returns:

Result of the ListMultiRegionAccessPoints operation returned by the service.

See Also:

• AWS API Documentation

listMultiRegionAccessPointsPaginator

default ListMultiRegionAccessPointsIterable listMultiRegionAccessPointsPaginator(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)
                                                                          throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

This is a variant of listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client
             .listMultiRegionAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation.

Parameters:

listMultiRegionAccessPointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMultiRegionAccessPointsPaginator

default ListMultiRegionAccessPointsIterable listMultiRegionAccessPointsPaginator(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)
                                                                          throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

This is a variant of listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client
             .listMultiRegionAccessPointsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation.

This is a convenience which creates an instance of the ListMultiRegionAccessPointsRequest.Builder avoiding the need to create one manually via ListMultiRegionAccessPointsRequest.builder()

Parameters:

listMultiRegionAccessPointsRequest - A Consumer that will call methods on ListMultiRegionAccessPointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRegionalBuckets

default ListRegionalBucketsResponse listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

Parameters:

listRegionalBucketsRequest -

Returns:

Result of the ListRegionalBuckets operation returned by the service.

See Also:

• AWS API Documentation

listRegionalBuckets

default ListRegionalBucketsResponse listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

This is a convenience which creates an instance of the ListRegionalBucketsRequest.Builder avoiding the need to create one manually via ListRegionalBucketsRequest.builder()

Parameters:

listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a request.

Returns:

Result of the ListRegionalBuckets operation returned by the service.

See Also:

• AWS API Documentation

listRegionalBucketsPaginator

default ListRegionalBucketsIterable listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest)
                                                          throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

This is a variant of listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client
             .listRegionalBucketsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation.

Parameters:

listRegionalBucketsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRegionalBucketsPaginator

default ListRegionalBucketsIterable listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)
                                                          throws AwsServiceException,
SdkClientException,
S3ControlException

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

This is a variant of listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client
             .listRegionalBucketsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults 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 listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation.

This is a convenience which creates an instance of the ListRegionalBucketsRequest.Builder avoiding the need to create one manually via ListRegionalBucketsRequest.builder()

Parameters:

listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStorageLensConfigurations

default ListStorageLensConfigurationsResponse listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)
                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

listStorageLensConfigurationsRequest -

Returns:

Result of the ListStorageLensConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listStorageLensConfigurations

default ListStorageLensConfigurationsResponse listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)
                                                                     throws AwsServiceException,
SdkClientException,
S3ControlException

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the ListStorageLensConfigurationsRequest.Builder avoiding the need to create one manually via ListStorageLensConfigurationsRequest.builder()

Parameters:

listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListStorageLensConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listStorageLensConfigurationsPaginator

default ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)
                                                                              throws AwsServiceException,
SdkClientException,
S3ControlException

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a variant of listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client
             .listStorageLensConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation.

Parameters:

listStorageLensConfigurationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStorageLensConfigurationsPaginator

default ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)
                                                                              throws AwsServiceException,
SdkClientException,
S3ControlException

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a variant of listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client
             .listStorageLensConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation.

This is a convenience which creates an instance of the ListStorageLensConfigurationsRequest.Builder avoiding the need to create one manually via ListStorageLensConfigurationsRequest.builder()

Parameters:

listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putAccessPointConfigurationForObjectLambda

default PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest)
                                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

• GetAccessPointConfigurationForObjectLambda

Parameters:

putAccessPointConfigurationForObjectLambdaRequest -

Returns:

Result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

putAccessPointConfigurationForObjectLambda

default PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest)
                                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

• GetAccessPointConfigurationForObjectLambda

This is a convenience which creates an instance of the PutAccessPointConfigurationForObjectLambdaRequest.Builder avoiding the need to create one manually via PutAccessPointConfigurationForObjectLambdaRequest.builder()

Parameters:

putAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on PutAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

putAccessPointPolicy

default PutAccessPointPolicyResponse putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

• GetAccessPointPolicy

• DeleteAccessPointPolicy

Parameters:

putAccessPointPolicyRequest -

Returns:

Result of the PutAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

putAccessPointPolicy

default PutAccessPointPolicyResponse putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

• GetAccessPointPolicy

• DeleteAccessPointPolicy

This is a convenience which creates an instance of the PutAccessPointPolicyRequest.Builder avoiding the need to create one manually via PutAccessPointPolicyRequest.builder()

Parameters:

putAccessPointPolicyRequest - A Consumer that will call methods on PutAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the PutAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

putAccessPointPolicyForObjectLambda

default PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest)
                                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to PutAccessPointPolicyForObjectLambda:

• DeleteAccessPointPolicyForObjectLambda

• GetAccessPointPolicyForObjectLambda

Parameters:

putAccessPointPolicyForObjectLambdaRequest -

Returns:

Result of the PutAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

putAccessPointPolicyForObjectLambda

default PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest)
                                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to PutAccessPointPolicyForObjectLambda:

• DeleteAccessPointPolicyForObjectLambda

• GetAccessPointPolicyForObjectLambda

This is a convenience which creates an instance of the PutAccessPointPolicyForObjectLambdaRequest.Builder avoiding the need to create one manually via PutAccessPointPolicyForObjectLambdaRequest.builder()

Parameters:

putAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on PutAccessPointPolicyForObjectLambdaRequest.Builder to create a request.

Returns:

Result of the PutAccessPointPolicyForObjectLambda operation returned by the service.

See Also:

• AWS API Documentation

putBucketLifecycleConfiguration

default PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketLifecycleConfiguration:

• GetBucketLifecycleConfiguration

• DeleteBucketLifecycleConfiguration

Parameters:

putBucketLifecycleConfigurationRequest -

Returns:

Result of the PutBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putBucketLifecycleConfiguration

default PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketLifecycleConfiguration:

• GetBucketLifecycleConfiguration

• DeleteBucketLifecycleConfiguration

This is a convenience which creates an instance of the PutBucketLifecycleConfigurationRequest.Builder avoiding the need to create one manually via PutBucketLifecycleConfigurationRequest.builder()

Parameters:

putBucketLifecycleConfigurationRequest - A Consumer that will call methods on PutBucketLifecycleConfigurationRequest.Builder to create a request.

Returns:

Result of the PutBucketLifecycleConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putBucketPolicy

default PutBucketPolicyResponse putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.

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.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketPolicy:

• GetBucketPolicy

• DeleteBucketPolicy

Parameters:

putBucketPolicyRequest -

Returns:

Result of the PutBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

putBucketPolicy

default PutBucketPolicyResponse putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
                                         throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.

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.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketPolicy:

• GetBucketPolicy

• DeleteBucketPolicy

This is a convenience which creates an instance of the PutBucketPolicyRequest.Builder avoiding the need to create one manually via PutBucketPolicyRequest.builder()

Parameters:

putBucketPolicyRequest - A Consumer that will call methods on PutBucketPolicyRequest.Builder to create a request.

Returns:

Result of the PutBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

putBucketReplication

default PutBucketReplicationResponse putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API Reference.

Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

Specify the replication configuration in the request body. In the replication configuration, you provide the following information:

• The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects

• The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf

• Other relevant information, such as replication rules

A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts 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 Outposts 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.

Using PutBucketReplication on Outposts requires that both the source and destination buckets must have versioning enabled. For information about enabling versioning on a bucket, see Managing S3 Versioning for your S3 on Outposts bucket.

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

Handling Replication of Encrypted Objects

Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.

Permissions

To create a PutBucketReplication request, you must have s3-outposts:PutReplicationConfiguration permissions for the bucket. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets.

To perform this operation, the user or role must also have the iam:CreateRole and iam:PassRole permissions. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to PutBucketReplication:

• GetBucketReplication

• DeleteBucketReplication

Parameters:

putBucketReplicationRequest -

Returns:

Result of the PutBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

putBucketReplication

default PutBucketReplicationResponse putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

This action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API Reference.

Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by a GET request soon after a PUT or DELETE request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.

Specify the replication configuration in the request body. In the replication configuration, you provide the following information:

• The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects

• The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf

• Other relevant information, such as replication rules

A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts 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 Outposts 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.

Using PutBucketReplication on Outposts requires that both the source and destination buckets must have versioning enabled. For information about enabling versioning on a bucket, see Managing S3 Versioning for your S3 on Outposts bucket.

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

Handling Replication of Encrypted Objects

Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.

Permissions

To create a PutBucketReplication request, you must have s3-outposts:PutReplicationConfiguration permissions for the bucket. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets.

To perform this operation, the user or role must also have the iam:CreateRole and iam:PassRole permissions. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to PutBucketReplication:

• GetBucketReplication

• DeleteBucketReplication

This is a convenience which creates an instance of the PutBucketReplicationRequest.Builder avoiding the need to create one manually via PutBucketReplicationRequest.builder()

Parameters:

putBucketReplicationRequest - A Consumer that will call methods on PutBucketReplicationRequest.Builder to create a request.

Returns:

Result of the PutBucketReplication operation returned by the service.

See Also:

• AWS API Documentation

putBucketTagging

default PutBucketTaggingResponse putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts 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.

PutBucketTagging has the following special errors:

• Error code: InvalidTagError

  • Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.

• Error code: MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code: OperationAbortedError

  • Description: A conflicting conditional action is currently in progress against this resource. Try again.

• Error code: InternalError

  • Description: The service was unable to apply the provided tag to the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

• GetBucketTagging

• DeleteBucketTagging

Parameters:

putBucketTaggingRequest -

Returns:

Result of the PutBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

putBucketTagging

default PutBucketTaggingResponse putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
                                           throws AwsServiceException,
SdkClientException,
S3ControlException

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts 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.

PutBucketTagging has the following special errors:

• Error code: InvalidTagError

  • Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.

• Error code: MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code: OperationAbortedError

  • Description: A conflicting conditional action is currently in progress against this resource. Try again.

• Error code: InternalError

  • Description: The service was unable to apply the provided tag to the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

• GetBucketTagging

• DeleteBucketTagging

This is a convenience which creates an instance of the PutBucketTaggingRequest.Builder avoiding the need to create one manually via PutBucketTaggingRequest.builder()

Parameters:

putBucketTaggingRequest - A Consumer that will call methods on PutBucketTaggingRequest.Builder to create a request.

Returns:

Result of the PutBucketTagging operation returned by the service.

See Also:

• AWS API Documentation

putBucketVersioning

default PutBucketVersioningResponse putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

You can set the versioning state to one of the following:

• Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

• Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.

When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.

If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to PutBucketVersioning for S3 on Outposts.

• GetBucketVersioning

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Parameters:

putBucketVersioningRequest -

Returns:

Result of the PutBucketVersioning operation returned by the service.

See Also:

• AWS API Documentation

putBucketVersioning

default PutBucketVersioningResponse putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

This operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

You can set the versioning state to one of the following:

• Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

• Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.

When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.

If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to PutBucketVersioning for S3 on Outposts.

• GetBucketVersioning

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

This is a convenience which creates an instance of the PutBucketVersioningRequest.Builder avoiding the need to create one manually via PutBucketVersioningRequest.builder()

Parameters:

putBucketVersioningRequest - A Consumer that will call methods on PutBucketVersioningRequest.Builder to create a request.

Returns:

Result of the PutBucketVersioning operation returned by the service.

See Also:

• AWS API Documentation

putJobTagging

default PutJobTaggingResponse putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
                                     throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
S3ControlException

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

• If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.

• For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.

• A few things to consider about using tags:

  • Amazon S3 limits the maximum number of tags to 50 tags per job.

  • You can associate up to 50 tags with a job as long as they have unique tag keys.

  • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.

  • The key and values are case sensitive.

  • For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.

To use the PutJobTagging operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

• CreateJob

• GetJobTagging

• DeleteJobTagging

Parameters:

putJobTaggingRequest -

Returns:

Result of the PutJobTagging operation returned by the service.

See Also:

• AWS API Documentation

putJobTagging

default PutJobTaggingResponse putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)
                                     throws InternalServiceException,
TooManyRequestsException,
NotFoundException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
S3ControlException

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

• If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.

• For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.

• A few things to consider about using tags:

  • Amazon S3 limits the maximum number of tags to 50 tags per job.

  • You can associate up to 50 tags with a job as long as they have unique tag keys.

  • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.

  • The key and values are case sensitive.

  • For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.

To use the PutJobTagging operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

• CreateJob

• GetJobTagging

• DeleteJobTagging

This is a convenience which creates an instance of the PutJobTaggingRequest.Builder avoiding the need to create one manually via PutJobTaggingRequest.builder()

Parameters:

putJobTaggingRequest - A Consumer that will call methods on PutJobTaggingRequest.Builder to create a request.

Returns:

Result of the PutJobTagging operation returned by the service.

See Also:

• AWS API Documentation

putMultiRegionAccessPointPolicy

default PutMultiRegionAccessPointPolicyResponse putMultiRegionAccessPointPolicy(PutMultiRegionAccessPointPolicyRequest putMultiRegionAccessPointPolicyRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to PutMultiRegionAccessPointPolicy:

• GetMultiRegionAccessPointPolicy

• GetMultiRegionAccessPointPolicyStatus

Parameters:

putMultiRegionAccessPointPolicyRequest -

Returns:

Result of the PutMultiRegionAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

putMultiRegionAccessPointPolicy

default PutMultiRegionAccessPointPolicyResponse putMultiRegionAccessPointPolicy(Consumer<PutMultiRegionAccessPointPolicyRequest.Builder> putMultiRegionAccessPointPolicyRequest)
                                                                         throws AwsServiceException,
SdkClientException,
S3ControlException

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to PutMultiRegionAccessPointPolicy:

• GetMultiRegionAccessPointPolicy

• GetMultiRegionAccessPointPolicyStatus

This is a convenience which creates an instance of the PutMultiRegionAccessPointPolicyRequest.Builder avoiding the need to create one manually via PutMultiRegionAccessPointPolicyRequest.builder()

Parameters:

putMultiRegionAccessPointPolicyRequest - A Consumer that will call methods on PutMultiRegionAccessPointPolicyRequest.Builder to create a request.

Returns:

Result of the PutMultiRegionAccessPointPolicy operation returned by the service.

See Also:

• AWS API Documentation

putPublicAccessBlock

default PutPublicAccessBlockResponse putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

• GetPublicAccessBlock

• DeletePublicAccessBlock

Parameters:

putPublicAccessBlockRequest -

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

putPublicAccessBlock

default PutPublicAccessBlockResponse putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
                                                   throws AwsServiceException,
SdkClientException,
S3ControlException

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

• GetPublicAccessBlock

• DeletePublicAccessBlock

This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder avoiding the need to create one manually via PutPublicAccessBlockRequest.builder()

Parameters:

putPublicAccessBlockRequest - A Consumer that will call methods on PutPublicAccessBlockRequest.Builder to create a request.

Returns:

Result of the PutPublicAccessBlock operation returned by the service.

See Also:

• AWS API Documentation

putStorageLensConfiguration

default PutStorageLensConfigurationResponse putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

putStorageLensConfigurationRequest -

Returns:

Result of the PutStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putStorageLensConfiguration

default PutStorageLensConfigurationResponse putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest)
                                                                 throws AwsServiceException,
SdkClientException,
S3ControlException

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the PutStorageLensConfigurationRequest.Builder avoiding the need to create one manually via PutStorageLensConfigurationRequest.builder()

Parameters:

putStorageLensConfigurationRequest - A Consumer that will call methods on PutStorageLensConfigurationRequest.Builder to create a request.

Returns:

Result of the PutStorageLensConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putStorageLensConfigurationTagging

default PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Parameters:

putStorageLensConfigurationTaggingRequest -

Returns:

Result of the PutStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

putStorageLensConfigurationTagging

default PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

This is a convenience which creates an instance of the PutStorageLensConfigurationTaggingRequest.Builder avoiding the need to create one manually via PutStorageLensConfigurationTaggingRequest.builder()

Parameters:

putStorageLensConfigurationTaggingRequest - A Consumer that will call methods on PutStorageLensConfigurationTaggingRequest.Builder to create a request.

Returns:

Result of the PutStorageLensConfigurationTagging operation returned by the service.

See Also:

• AWS API Documentation

submitMultiRegionAccessPointRoutes

default SubmitMultiRegionAccessPointRoutesResponse submitMultiRegionAccessPointRoutes(SubmitMultiRegionAccessPointRoutesRequest submitMultiRegionAccessPointRoutesRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of 0 indicates a passive status, which means that traffic won't be routed to the specified Region. A value of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.

Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.

To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

• us-east-1

• us-west-2

• ap-southeast-2

• ap-northeast-1

• eu-west-1

Your Amazon S3 bucket does not need to be in these five Regions.

Parameters:

submitMultiRegionAccessPointRoutesRequest -

Returns:

Result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.

See Also:

• AWS API Documentation

submitMultiRegionAccessPointRoutes

default SubmitMultiRegionAccessPointRoutesResponse submitMultiRegionAccessPointRoutes(Consumer<SubmitMultiRegionAccessPointRoutesRequest.Builder> submitMultiRegionAccessPointRoutesRequest)
                                                                               throws AwsServiceException,
SdkClientException,
S3ControlException

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of 0 indicates a passive status, which means that traffic won't be routed to the specified Region. A value of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.

Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.

To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

• us-east-1

• us-west-2

• ap-southeast-2

• ap-northeast-1

• eu-west-1

Your Amazon S3 bucket does not need to be in these five Regions.

This is a convenience which creates an instance of the SubmitMultiRegionAccessPointRoutesRequest.Builder avoiding the need to create one manually via SubmitMultiRegionAccessPointRoutesRequest.builder()

Parameters:

submitMultiRegionAccessPointRoutesRequest - A Consumer that will call methods on SubmitMultiRegionAccessPointRoutesRequest.Builder to create a request.

Returns:

Result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.

See Also:

• AWS API Documentation

updateJobPriority

default UpdateJobPriorityResponse updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)
                                             throws BadRequestException,
TooManyRequestsException,
NotFoundException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• DescribeJob

• UpdateJobStatus

Parameters:

updateJobPriorityRequest -

Returns:

Result of the UpdateJobPriority operation returned by the service.

See Also:

• AWS API Documentation

updateJobPriority

default UpdateJobPriorityResponse updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)
                                             throws BadRequestException,
TooManyRequestsException,
NotFoundException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• DescribeJob

• UpdateJobStatus

This is a convenience which creates an instance of the UpdateJobPriorityRequest.Builder avoiding the need to create one manually via UpdateJobPriorityRequest.builder()

Parameters:

updateJobPriorityRequest - A Consumer that will call methods on UpdateJobPriorityRequest.Builder to create a request.

Returns:

Result of the UpdateJobPriority operation returned by the service.

See Also:

• AWS API Documentation

updateJobStatus

default UpdateJobStatusResponse updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
                                         throws BadRequestException,
TooManyRequestsException,
NotFoundException,
JobStatusException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• DescribeJob

• UpdateJobStatus

Parameters:

updateJobStatusRequest -

Returns:

Result of the UpdateJobStatus operation returned by the service.

See Also:

• AWS API Documentation

updateJobStatus

default UpdateJobStatusResponse updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)
                                         throws BadRequestException,
TooManyRequestsException,
NotFoundException,
JobStatusException,
InternalServiceException,
AwsServiceException,
SdkClientException,
S3ControlException

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• CreateJob

• ListJobs

• DescribeJob

• UpdateJobStatus

This is a convenience which creates an instance of the UpdateJobStatusRequest.Builder avoiding the need to create one manually via UpdateJobStatusRequest.builder()

Parameters:

updateJobStatusRequest - A Consumer that will call methods on UpdateJobStatusRequest.Builder to create a request.

Returns:

Result of the UpdateJobStatus operation returned by the service.

See Also:

• AWS API Documentation

create

static S3ControlClient create()

Create a S3ControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static S3ControlClientBuilder builder()

Create a builder that can be used to configure and create a S3ControlClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default S3ControlServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration