@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSS3ControlAsync extends AWSS3Control
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSS3ControlAsync instead.
AWS S3 Control provides access to Amazon S3 control plane operations.
ENDPOINT_PREFIXcreateAccessPoint, createBucket, createJob, deleteAccessPoint, deleteAccessPointPolicy, deleteBucket, deleteBucketLifecycleConfiguration, deleteBucketPolicy, deleteBucketTagging, deleteJobTagging, deletePublicAccessBlock, deleteStorageLensConfiguration, deleteStorageLensConfigurationTagging, describeJob, getAccessPoint, getAccessPointPolicy, getAccessPointPolicyStatus, getBucket, getBucketLifecycleConfiguration, getBucketPolicy, getBucketTagging, getCachedResponseMetadata, getJobTagging, getPublicAccessBlock, getStorageLensConfiguration, getStorageLensConfigurationTagging, listAccessPoints, listJobs, listRegionalBuckets, listStorageLensConfigurations, putAccessPointPolicy, putBucketLifecycleConfiguration, putBucketPolicy, putBucketTagging, putJobTagging, putPublicAccessBlock, putStorageLensConfiguration, putStorageLensConfigurationTagging, shutdown, updateJobPriority, updateJobStatusFuture<CreateAccessPointResult> createAccessPointAsync(CreateAccessPointRequest createAccessPointRequest)
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 Simple Storage Service Developer Guide.
Using this action with Amazon S3 on Outposts
This action:
Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
Does not support ACL on S3 on Outposts buckets.
Does not support Public Access on S3 on Outposts buckets.
Does not support object lock for S3 on Outposts buckets.
For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to CreateAccessPoint:
createAccessPointRequest - Future<CreateAccessPointResult> createAccessPointAsync(CreateAccessPointRequest createAccessPointRequest, AsyncHandler<CreateAccessPointRequest,CreateAccessPointResult> asyncHandler)
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 Simple Storage Service Developer Guide.
Using this action with Amazon S3 on Outposts
This action:
Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
Does not support ACL on S3 on Outposts buckets.
Does not support Public Access on S3 on Outposts buckets.
Does not support object lock for S3 on Outposts buckets.
For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to CreateAccessPoint:
createAccessPointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBucketResult> createBucketAsync(CreateBucketRequest createBucketRequest)
This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer 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 do not support
ACLs. Instead, configure access point policies to manage access to buckets.
Public access.
Object Lock
Bucket Location constraint
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:
createBucketRequest - Future<CreateBucketResult> createBucketAsync(CreateBucketRequest createBucketRequest, AsyncHandler<CreateBucketRequest,CreateBucketResult> asyncHandler)
This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer 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 do not support
ACLs. Instead, configure access point policies to manage access to buckets.
Public access.
Object Lock
Bucket Location constraint
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:
createBucketRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
This operation creates an S3 Batch Operations job.
Related actions include:
createJobRequest - Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
This operation creates an S3 Batch Operations job.
Related actions include:
createJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAccessPointResult> deleteAccessPointAsync(DeleteAccessPointRequest deleteAccessPointRequest)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteAccessPoint:
deleteAccessPointRequest - Future<DeleteAccessPointResult> deleteAccessPointAsync(DeleteAccessPointRequest deleteAccessPointRequest, AsyncHandler<DeleteAccessPointRequest,DeleteAccessPointResult> asyncHandler)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteAccessPoint:
deleteAccessPointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAccessPointPolicyResult> deleteAccessPointPolicyAsync(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
deleteAccessPointPolicyRequest - Future<DeleteAccessPointPolicyResult> deleteAccessPointPolicyAsync(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest, AsyncHandler<DeleteAccessPointPolicyRequest,DeleteAccessPointPolicyResult> asyncHandler)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
deleteAccessPointPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBucketResult> deleteBucketAsync(DeleteBucketRequest deleteBucketRequest)
This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer 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 and 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 using the access point ARN,
see the Examples section.
Related Resources
deleteBucketRequest - Future<DeleteBucketResult> deleteBucketAsync(DeleteBucketRequest deleteBucketRequest, AsyncHandler<DeleteBucketRequest,DeleteBucketResult> asyncHandler)
This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer 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 and 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 using the access point ARN,
see the Examples section.
Related Resources
deleteBucketRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBucketLifecycleConfigurationResult> deleteBucketLifecycleConfigurationAsync(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
deleteBucketLifecycleConfigurationRequest - Future<DeleteBucketLifecycleConfigurationResult> deleteBucketLifecycleConfigurationAsync(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest, AsyncHandler<DeleteBucketLifecycleConfigurationRequest,DeleteBucketLifecycleConfigurationResult> asyncHandler)
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
deleteBucketLifecycleConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBucketPolicyResult> deleteBucketPolicyAsync(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE operation 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 AWS 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 operation. For more information,
see Using Amazon S3 on Outposts
in Amazon Simple Storage Service Developer 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 AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteBucketPolicy:
deleteBucketPolicyRequest - Future<DeleteBucketPolicyResult> deleteBucketPolicyAsync(DeleteBucketPolicyRequest deleteBucketPolicyRequest, AsyncHandler<DeleteBucketPolicyRequest,DeleteBucketPolicyResult> asyncHandler)
This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE operation 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 AWS 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 operation. For more information,
see Using Amazon S3 on Outposts
in Amazon Simple Storage Service Developer 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 AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteBucketPolicy:
deleteBucketPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBucketTaggingResult> deleteBucketTaggingAsync(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
This operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteBucketTagging:
deleteBucketTaggingRequest - Future<DeleteBucketTaggingResult> deleteBucketTaggingAsync(DeleteBucketTaggingRequest deleteBucketTaggingRequest, AsyncHandler<DeleteBucketTaggingRequest,DeleteBucketTaggingResult> asyncHandler)
This operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to DeleteBucketTagging:
deleteBucketTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteJobTaggingResult> deleteJobTaggingAsync(DeleteJobTaggingRequest deleteJobTaggingRequest)
Removes the entire tag set from the specified S3 Batch Operations job. To use this 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 Simple Storage Service Developer Guide.
Related actions include:
deleteJobTaggingRequest - Future<DeleteJobTaggingResult> deleteJobTaggingAsync(DeleteJobTaggingRequest deleteJobTaggingRequest, AsyncHandler<DeleteJobTaggingRequest,DeleteJobTaggingResult> asyncHandler)
Removes the entire tag set from the specified S3 Batch Operations job. To use this 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 Simple Storage Service Developer Guide.
Related actions include:
deleteJobTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePublicAccessBlockResult> deletePublicAccessBlockAsync(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
deletePublicAccessBlockRequest - Future<DeletePublicAccessBlockResult> deletePublicAccessBlockAsync(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest, AsyncHandler<DeletePublicAccessBlockRequest,DeletePublicAccessBlockResult> asyncHandler)
Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
deletePublicAccessBlockRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStorageLensConfigurationResult> deleteStorageLensConfigurationAsync(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest)
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
deleteStorageLensConfigurationRequest - Future<DeleteStorageLensConfigurationResult> deleteStorageLensConfigurationAsync(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest, AsyncHandler<DeleteStorageLensConfigurationRequest,DeleteStorageLensConfigurationResult> asyncHandler)
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
deleteStorageLensConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStorageLensConfigurationTaggingResult> deleteStorageLensConfigurationTaggingAsync(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest)
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
deleteStorageLensConfigurationTaggingRequest - Future<DeleteStorageLensConfigurationTaggingResult> deleteStorageLensConfigurationTaggingAsync(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest, AsyncHandler<DeleteStorageLensConfigurationTaggingRequest,DeleteStorageLensConfigurationTaggingResult> asyncHandler)
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
deleteStorageLensConfigurationTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest)
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
describeJobRequest - Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
describeJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccessPointResult> getAccessPointAsync(GetAccessPointRequest getAccessPointRequest)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetAccessPoint:
getAccessPointRequest - Future<GetAccessPointResult> getAccessPointAsync(GetAccessPointRequest getAccessPointRequest, AsyncHandler<GetAccessPointRequest,GetAccessPointResult> asyncHandler)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetAccessPoint:
getAccessPointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccessPointPolicyResult> getAccessPointPolicyAsync(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
getAccessPointPolicyRequest - Future<GetAccessPointPolicyResult> getAccessPointPolicyAsync(GetAccessPointPolicyRequest getAccessPointPolicyRequest, AsyncHandler<GetAccessPointPolicyRequest,GetAccessPointPolicyResult> asyncHandler)
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
getAccessPointPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccessPointPolicyStatusResult> getAccessPointPolicyStatusAsync(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
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 Simple Storage Service Developer Guide.
getAccessPointPolicyStatusRequest - Future<GetAccessPointPolicyStatusResult> getAccessPointPolicyStatusAsync(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest, AsyncHandler<GetAccessPointPolicyStatusRequest,GetAccessPointPolicyStatusResult> asyncHandler)
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 Simple Storage Service Developer Guide.
getAccessPointPolicyStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBucketResult> getBucketAsync(GetBucketRequest getBucketRequest)
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling
identity must have the s3-outposts:GetBucket permissions on the specified bucket and belong to the
bucket owner's account in order to use this operation. 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 and 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 using the access point ARN,
see the Examples section.
getBucketRequest - Future<GetBucketResult> getBucketAsync(GetBucketRequest getBucketRequest, AsyncHandler<GetBucketRequest,GetBucketResult> asyncHandler)
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling
identity must have the s3-outposts:GetBucket permissions on the specified bucket and belong to the
bucket owner's account in order to use this operation. 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 and 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 using the access point ARN,
see the Examples section.
getBucketRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBucketLifecycleConfigurationResult> getBucketLifecycleConfigurationAsync(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer Guide.
To use this operation, 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 and 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 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:
getBucketLifecycleConfigurationRequest - Future<GetBucketLifecycleConfigurationResult> getBucketLifecycleConfigurationAsync(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest, AsyncHandler<GetBucketLifecycleConfigurationRequest,GetBucketLifecycleConfigurationResult> asyncHandler)
This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
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 Simple Storage Service Developer Guide.
To use this operation, 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 and 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 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:
getBucketLifecycleConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBucketPolicyResult> getBucketPolicyAsync(GetBucketPolicyRequest getBucketPolicyRequest)
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 Simple Storage Service API.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling
identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation.
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 AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetBucketPolicy:
getBucketPolicyRequest - Future<GetBucketPolicyResult> getBucketPolicyAsync(GetBucketPolicyRequest getBucketPolicyRequest, AsyncHandler<GetBucketPolicyRequest,GetBucketPolicyResult> asyncHandler)
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 Simple Storage Service API.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling
identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation.
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 AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetBucketPolicy:
getBucketPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBucketTaggingResult> getBucketTaggingAsync(GetBucketTaggingRequest getBucketTaggingRequest)
This operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetBucketTagging:
getBucketTaggingRequest - Future<GetBucketTaggingResult> getBucketTaggingAsync(GetBucketTaggingRequest getBucketTaggingRequest, AsyncHandler<GetBucketTaggingRequest,GetBucketTaggingResult> asyncHandler)
This operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
To use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to GetBucketTagging:
getBucketTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetJobTaggingResult> getJobTaggingAsync(GetJobTaggingRequest getJobTaggingRequest)
Returns the tags on an S3 Batch Operations job. To use this 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 Simple Storage Service Developer Guide.
Related actions include:
getJobTaggingRequest - Future<GetJobTaggingResult> getJobTaggingAsync(GetJobTaggingRequest getJobTaggingRequest, AsyncHandler<GetJobTaggingRequest,GetJobTaggingResult> asyncHandler)
Returns the tags on an S3 Batch Operations job. To use this 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 Simple Storage Service Developer Guide.
Related actions include:
getJobTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPublicAccessBlockResult> getPublicAccessBlockAsync(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
getPublicAccessBlockRequest - Future<GetPublicAccessBlockResult> getPublicAccessBlockAsync(GetPublicAccessBlockRequest getPublicAccessBlockRequest, AsyncHandler<GetPublicAccessBlockRequest,GetPublicAccessBlockResult> asyncHandler)
Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
getPublicAccessBlockRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStorageLensConfigurationResult> getStorageLensConfigurationAsync(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest)
Gets the Amazon S3 Storage Lens configuration. For more information, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
getStorageLensConfigurationRequest - Future<GetStorageLensConfigurationResult> getStorageLensConfigurationAsync(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest, AsyncHandler<GetStorageLensConfigurationRequest,GetStorageLensConfigurationResult> asyncHandler)
Gets the Amazon S3 Storage Lens configuration. For more information, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
getStorageLensConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStorageLensConfigurationTaggingResult> getStorageLensConfigurationTaggingAsync(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest)
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
getStorageLensConfigurationTaggingRequest - Future<GetStorageLensConfigurationTaggingResult> getStorageLensConfigurationTaggingAsync(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest, AsyncHandler<GetStorageLensConfigurationTaggingRequest,GetStorageLensConfigurationTaggingResult> asyncHandler)
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
getStorageLensConfigurationTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAccessPointsResult> listAccessPointsAsync(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to ListAccessPoints:
listAccessPointsRequest - Future<ListAccessPointsResult> listAccessPointsAsync(ListAccessPointsRequest listAccessPointsRequest, AsyncHandler<ListAccessPointsRequest,ListAccessPointsResult> asyncHandler)
Returns a list of the access points currently 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to ListAccessPoints:
listAccessPointsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
listJobsRequest - Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
listJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRegionalBucketsResult> listRegionalBucketsAsync(ListRegionalBucketsRequest listRegionalBucketsRequest)
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 Simple Storage Service Developer 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.
listRegionalBucketsRequest - Future<ListRegionalBucketsResult> listRegionalBucketsAsync(ListRegionalBucketsRequest listRegionalBucketsRequest, AsyncHandler<ListRegionalBucketsRequest,ListRegionalBucketsResult> asyncHandler)
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 Simple Storage Service Developer 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.
listRegionalBucketsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListStorageLensConfigurationsResult> listStorageLensConfigurationsAsync(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
listStorageLensConfigurationsRequest - Future<ListStorageLensConfigurationsResult> listStorageLensConfigurationsAsync(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest, AsyncHandler<ListStorageLensConfigurationsRequest,ListStorageLensConfigurationsResult> asyncHandler)
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
listStorageLensConfigurationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutAccessPointPolicyResult> putAccessPointPolicyAsync(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutAccessPointPolicy:
putAccessPointPolicyRequest - Future<PutAccessPointPolicyResult> putAccessPointPolicyAsync(PutAccessPointPolicyRequest putAccessPointPolicyRequest, AsyncHandler<PutAccessPointPolicyRequest,PutAccessPointPolicyResult> asyncHandler)
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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutAccessPointPolicy:
putAccessPointPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBucketLifecycleConfigurationResult> putBucketLifecycleConfigurationAsync(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
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 Simple Storage Service API.
Creates a new lifecycle configuration for the 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. For more information, see Managing Lifecycle Permissions 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketLifecycleConfiguration:
putBucketLifecycleConfigurationRequest - Future<PutBucketLifecycleConfigurationResult> putBucketLifecycleConfigurationAsync(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest, AsyncHandler<PutBucketLifecycleConfigurationRequest,PutBucketLifecycleConfigurationResult> asyncHandler)
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 Simple Storage Service API.
Creates a new lifecycle configuration for the 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. For more information, see Managing Lifecycle Permissions 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketLifecycleConfiguration:
putBucketLifecycleConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBucketPolicyResult> putBucketPolicyAsync(PutBucketPolicyRequest putBucketPolicyRequest)
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 Simple Storage Service API.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS 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 operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketPolicy:
putBucketPolicyRequest - Future<PutBucketPolicyResult> putBucketPolicyAsync(PutBucketPolicyRequest putBucketPolicyRequest, AsyncHandler<PutBucketPolicyRequest,PutBucketPolicyResult> asyncHandler)
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 Simple Storage Service API.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS 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 operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketPolicy:
putBucketPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBucketTaggingResult> putBucketTaggingAsync(PutBucketTaggingRequest putBucketTaggingRequest)
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS 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 operation, 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 AWS-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional operation 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketTagging:
putBucketTaggingRequest - Future<PutBucketTaggingResult> putBucketTaggingAsync(PutBucketTaggingRequest putBucketTaggingRequest, AsyncHandler<PutBucketTaggingRequest,PutBucketTaggingResult> asyncHandler)
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS 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 operation, 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 AWS-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional operation 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 and 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 using the access point ARN,
see the Examples section.
The following actions are related to PutBucketTagging:
putBucketTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutJobTaggingResult> putJobTaggingAsync(PutJobTaggingRequest putJobTaggingRequest)
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 Simple Storage Service Developer 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 AWS Billing and Cost Management User Guide.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTaggingRequest - Future<PutJobTaggingResult> putJobTaggingAsync(PutJobTaggingRequest putJobTaggingRequest, AsyncHandler<PutJobTaggingRequest,PutJobTaggingResult> asyncHandler)
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 Simple Storage Service Developer 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 AWS Billing and Cost Management User Guide.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutPublicAccessBlockResult> putPublicAccessBlockAsync(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information,
see Using
Amazon S3 block public access.
Related actions include:
putPublicAccessBlockRequest - Future<PutPublicAccessBlockResult> putPublicAccessBlockAsync(PutPublicAccessBlockRequest putPublicAccessBlockRequest, AsyncHandler<PutPublicAccessBlockRequest,PutPublicAccessBlockResult> asyncHandler)
Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information,
see Using
Amazon S3 block public access.
Related actions include:
putPublicAccessBlockRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutStorageLensConfigurationResult> putStorageLensConfigurationAsync(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest)
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
putStorageLensConfigurationRequest - Future<PutStorageLensConfigurationResult> putStorageLensConfigurationAsync(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest, AsyncHandler<PutStorageLensConfigurationRequest,PutStorageLensConfigurationResult> asyncHandler)
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
putStorageLensConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutStorageLensConfigurationTaggingResult> putStorageLensConfigurationTaggingAsync(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest)
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
putStorageLensConfigurationTaggingRequest - Future<PutStorageLensConfigurationTaggingResult> putStorageLensConfigurationTaggingAsync(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest, AsyncHandler<PutStorageLensConfigurationTaggingRequest,PutStorageLensConfigurationTaggingResult> asyncHandler)
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer 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 Simple Storage Service Developer Guide.
putStorageLensConfigurationTaggingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateJobPriorityResult> updateJobPriorityAsync(UpdateJobPriorityRequest updateJobPriorityRequest)
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobPriorityRequest - Future<UpdateJobPriorityResult> updateJobPriorityAsync(UpdateJobPriorityRequest updateJobPriorityRequest, AsyncHandler<UpdateJobPriorityRequest,UpdateJobPriorityResult> asyncHandler)
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobPriorityRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateJobStatusResult> updateJobStatusAsync(UpdateJobStatusRequest updateJobStatusRequest)
Updates the status for the specified job. Use this operation 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 Simple Storage Service Developer Guide.
Related actions include:
updateJobStatusRequest - Future<UpdateJobStatusResult> updateJobStatusAsync(UpdateJobStatusRequest updateJobStatusRequest, AsyncHandler<UpdateJobStatusRequest,UpdateJobStatusResult> asyncHandler)
Updates the status for the specified job. Use this operation 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 Simple Storage Service Developer Guide.
Related actions include:
updateJobStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.