@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSS3ControlAsyncClient extends AWSS3ControlClient implements AWSS3ControlAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
AWS S3 Control provides access to Amazon S3 control plane operations.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createAccessPoint, createJob, deleteAccessPoint, deleteAccessPointPolicy, deleteJobTagging, deletePublicAccessBlock, describeJob, getAccessPoint, getAccessPointPolicy, getAccessPointPolicyStatus, getCachedResponseMetadata, getJobTagging, getPublicAccessBlock, listAccessPoints, listJobs, putAccessPointPolicy, putJobTagging, putPublicAccessBlock, updateJobPriority, updateJobStatusaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateAccessPoint, createJob, deleteAccessPoint, deleteAccessPointPolicy, deleteJobTagging, deletePublicAccessBlock, describeJob, getAccessPoint, getAccessPointPolicy, getAccessPointPolicyStatus, getCachedResponseMetadata, getJobTagging, getPublicAccessBlock, listAccessPoints, listJobs, putAccessPointPolicy, putJobTagging, putPublicAccessBlock, updateJobPriority, updateJobStatuspublic static AWSS3ControlAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateAccessPointResult> createAccessPointAsync(CreateAccessPointRequest request)
AWSS3ControlAsyncCreates an access point and associates it with the specified bucket.
createAccessPointAsync in interface AWSS3ControlAsyncpublic Future<CreateAccessPointResult> createAccessPointAsync(CreateAccessPointRequest request, AsyncHandler<CreateAccessPointRequest,CreateAccessPointResult> asyncHandler)
AWSS3ControlAsyncCreates an access point and associates it with the specified bucket.
createAccessPointAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<CreateJobResult> createJobAsync(CreateJobRequest request)
AWSS3ControlAsyncYou can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
createJobAsync in interface AWSS3ControlAsyncpublic Future<CreateJobResult> createJobAsync(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
AWSS3ControlAsyncYou can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
createJobAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<DeleteAccessPointResult> deleteAccessPointAsync(DeleteAccessPointRequest request)
AWSS3ControlAsyncDeletes the specified access point.
deleteAccessPointAsync in interface AWSS3ControlAsyncpublic Future<DeleteAccessPointResult> deleteAccessPointAsync(DeleteAccessPointRequest request, AsyncHandler<DeleteAccessPointRequest,DeleteAccessPointResult> asyncHandler)
AWSS3ControlAsyncDeletes the specified access point.
deleteAccessPointAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<DeleteAccessPointPolicyResult> deleteAccessPointPolicyAsync(DeleteAccessPointPolicyRequest request)
AWSS3ControlAsyncDeletes the access point policy for the specified access point.
deleteAccessPointPolicyAsync in interface AWSS3ControlAsyncpublic Future<DeleteAccessPointPolicyResult> deleteAccessPointPolicyAsync(DeleteAccessPointPolicyRequest request, AsyncHandler<DeleteAccessPointPolicyRequest,DeleteAccessPointPolicyResult> asyncHandler)
AWSS3ControlAsyncDeletes the access point policy for the specified access point.
deleteAccessPointPolicyAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<DeleteJobTaggingResult> deleteJobTaggingAsync(DeleteJobTaggingRequest request)
AWSS3ControlAsync
Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must
have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job
Tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
deleteJobTaggingAsync in interface AWSS3ControlAsyncpublic Future<DeleteJobTaggingResult> deleteJobTaggingAsync(DeleteJobTaggingRequest request, AsyncHandler<DeleteJobTaggingRequest,DeleteJobTaggingResult> asyncHandler)
AWSS3ControlAsync
Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must
have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job
Tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
deleteJobTaggingAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<DeletePublicAccessBlockResult> deletePublicAccessBlockAsync(DeletePublicAccessBlockRequest request)
AWSS3ControlAsync
Removes the PublicAccessBlock configuration for an Amazon Web Services account.
deletePublicAccessBlockAsync in interface AWSS3ControlAsyncpublic Future<DeletePublicAccessBlockResult> deletePublicAccessBlockAsync(DeletePublicAccessBlockRequest request, AsyncHandler<DeletePublicAccessBlockRequest,DeletePublicAccessBlockResult> asyncHandler)
AWSS3ControlAsync
Removes the PublicAccessBlock configuration for an Amazon Web Services account.
deletePublicAccessBlockAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request)
AWSS3ControlAsyncRetrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
describeJobAsync in interface AWSS3ControlAsyncpublic Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)
AWSS3ControlAsyncRetrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
describeJobAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<GetAccessPointResult> getAccessPointAsync(GetAccessPointRequest request)
AWSS3ControlAsyncReturns configuration information about the specified access point.
getAccessPointAsync in interface AWSS3ControlAsyncpublic Future<GetAccessPointResult> getAccessPointAsync(GetAccessPointRequest request, AsyncHandler<GetAccessPointRequest,GetAccessPointResult> asyncHandler)
AWSS3ControlAsyncReturns configuration information about the specified access point.
getAccessPointAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<GetAccessPointPolicyResult> getAccessPointPolicyAsync(GetAccessPointPolicyRequest request)
AWSS3ControlAsyncReturns the access point policy associated with the specified access point.
getAccessPointPolicyAsync in interface AWSS3ControlAsyncpublic Future<GetAccessPointPolicyResult> getAccessPointPolicyAsync(GetAccessPointPolicyRequest request, AsyncHandler<GetAccessPointPolicyRequest,GetAccessPointPolicyResult> asyncHandler)
AWSS3ControlAsyncReturns the access point policy associated with the specified access point.
getAccessPointPolicyAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<GetAccessPointPolicyStatusResult> getAccessPointPolicyStatusAsync(GetAccessPointPolicyStatusRequest request)
AWSS3ControlAsyncIndicates 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.
getAccessPointPolicyStatusAsync in interface AWSS3ControlAsyncpublic Future<GetAccessPointPolicyStatusResult> getAccessPointPolicyStatusAsync(GetAccessPointPolicyStatusRequest request, AsyncHandler<GetAccessPointPolicyStatusRequest,GetAccessPointPolicyStatusResult> asyncHandler)
AWSS3ControlAsyncIndicates 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.
getAccessPointPolicyStatusAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<GetJobTaggingResult> getJobTaggingAsync(GetJobTaggingRequest request)
AWSS3ControlAsync
Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform
the s3:GetJobTagging action. For more information, see Using Job
Tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
getJobTaggingAsync in interface AWSS3ControlAsyncpublic Future<GetJobTaggingResult> getJobTaggingAsync(GetJobTaggingRequest request, AsyncHandler<GetJobTaggingRequest,GetJobTaggingResult> asyncHandler)
AWSS3ControlAsync
Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform
the s3:GetJobTagging action. For more information, see Using Job
Tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
getJobTaggingAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<GetPublicAccessBlockResult> getPublicAccessBlockAsync(GetPublicAccessBlockRequest request)
AWSS3ControlAsync
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
getPublicAccessBlockAsync in interface AWSS3ControlAsyncpublic Future<GetPublicAccessBlockResult> getPublicAccessBlockAsync(GetPublicAccessBlockRequest request, AsyncHandler<GetPublicAccessBlockRequest,GetPublicAccessBlockResult> asyncHandler)
AWSS3ControlAsync
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
getPublicAccessBlockAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<ListAccessPointsResult> listAccessPointsAsync(ListAccessPointsRequest request)
AWSS3ControlAsync
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.
listAccessPointsAsync in interface AWSS3ControlAsyncpublic Future<ListAccessPointsResult> listAccessPointsAsync(ListAccessPointsRequest request, AsyncHandler<ListAccessPointsRequest,ListAccessPointsResult> asyncHandler)
AWSS3ControlAsync
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.
listAccessPointsAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<ListJobsResult> listJobsAsync(ListJobsRequest request)
AWSS3ControlAsyncLists current Amazon 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 Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
listJobsAsync in interface AWSS3ControlAsyncpublic Future<ListJobsResult> listJobsAsync(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
AWSS3ControlAsyncLists current Amazon 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 Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
listJobsAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<PutAccessPointPolicyResult> putAccessPointPolicyAsync(PutAccessPointPolicyRequest request)
AWSS3ControlAsyncAssociates 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.
putAccessPointPolicyAsync in interface AWSS3ControlAsyncpublic Future<PutAccessPointPolicyResult> putAccessPointPolicyAsync(PutAccessPointPolicyRequest request, AsyncHandler<PutAccessPointPolicyRequest,PutAccessPointPolicyResult> asyncHandler)
AWSS3ControlAsyncAssociates 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.
putAccessPointPolicyAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<PutJobTaggingResult> putJobTaggingAsync(PutJobTaggingRequest request)
AWSS3ControlAsyncSet the supplied tag-set on an Amazon S3 Batch Operations job.
A tag is a key-value pair. You can associate Amazon 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 API action to replace the tag set with the one you have modified.. For more information, see Using Job 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 will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your batch operations job, 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.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTaggingAsync in interface AWSS3ControlAsyncpublic Future<PutJobTaggingResult> putJobTaggingAsync(PutJobTaggingRequest request, AsyncHandler<PutJobTaggingRequest,PutJobTaggingResult> asyncHandler)
AWSS3ControlAsyncSet the supplied tag-set on an Amazon S3 Batch Operations job.
A tag is a key-value pair. You can associate Amazon 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 API action to replace the tag set with the one you have modified.. For more information, see Using Job 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 will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your batch operations job, 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.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTaggingAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<PutPublicAccessBlockResult> putPublicAccessBlockAsync(PutPublicAccessBlockRequest request)
AWSS3ControlAsync
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
putPublicAccessBlockAsync in interface AWSS3ControlAsyncpublic Future<PutPublicAccessBlockResult> putPublicAccessBlockAsync(PutPublicAccessBlockRequest request, AsyncHandler<PutPublicAccessBlockRequest,PutPublicAccessBlockResult> asyncHandler)
AWSS3ControlAsync
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
putPublicAccessBlockAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<UpdateJobPriorityResult> updateJobPriorityAsync(UpdateJobPriorityRequest request)
AWSS3ControlAsyncUpdates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobPriorityAsync in interface AWSS3ControlAsyncpublic Future<UpdateJobPriorityResult> updateJobPriorityAsync(UpdateJobPriorityRequest request, AsyncHandler<UpdateJobPriorityRequest,UpdateJobPriorityResult> asyncHandler)
AWSS3ControlAsyncUpdates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobPriorityAsync in interface AWSS3ControlAsyncasyncHandler - 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.public Future<UpdateJobStatusResult> updateJobStatusAsync(UpdateJobStatusRequest request)
AWSS3ControlAsyncUpdates 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 Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobStatusAsync in interface AWSS3ControlAsyncpublic Future<UpdateJobStatusResult> updateJobStatusAsync(UpdateJobStatusRequest request, AsyncHandler<UpdateJobStatusRequest,UpdateJobStatusResult> asyncHandler)
AWSS3ControlAsyncUpdates 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 Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
updateJobStatusAsync in interface AWSS3ControlAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSS3Controlshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.