@Generated(value="software.amazon.awssdk:codegen") public interface S3ControlClient extends SdkClient
builder() method.
AWS S3 Control provides access to Amazon S3 control plane actions.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static S3ControlClientBuilder |
builder()
Create a builder that can be used to configure and create a
S3ControlClient. |
static S3ControlClient |
create()
Create a
S3ControlClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAccessPointResponse |
createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
|
default CreateAccessPointResponse |
createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
|
default CreateAccessPointForObjectLambdaResponse |
createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest)
Creates an Object Lambda Access Point.
|
default CreateAccessPointForObjectLambdaResponse |
createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest)
Creates an Object Lambda Access Point.
|
default CreateBucketResponse |
createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
|
default CreateBucketResponse |
createBucket(CreateBucketRequest createBucketRequest)
|
default CreateJobResponse |
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
|
default CreateJobResponse |
createJob(CreateJobRequest createJobRequest)
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
|
default DeleteAccessPointResponse |
deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
Deletes the specified access point.
|
default DeleteAccessPointResponse |
deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
Deletes the specified access point.
|
default DeleteAccessPointForObjectLambdaResponse |
deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest)
Deletes the specified Object Lambda Access Point.
|
default DeleteAccessPointForObjectLambdaResponse |
deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest)
Deletes the specified Object Lambda Access Point.
|
default DeleteAccessPointPolicyResponse |
deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
|
default DeleteAccessPointPolicyResponse |
deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
|
default DeleteAccessPointPolicyForObjectLambdaResponse |
deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest)
Removes the resource policy for an Object Lambda Access Point.
|
default DeleteAccessPointPolicyForObjectLambdaResponse |
deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest)
Removes the resource policy for an Object Lambda Access Point.
|
default DeleteBucketResponse |
deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
|
default DeleteBucketResponse |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
|
default DeleteBucketLifecycleConfigurationResponse |
deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest)
|
default DeleteBucketLifecycleConfigurationResponse |
deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)
|
default DeleteBucketPolicyResponse |
deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
|
default DeleteBucketPolicyResponse |
deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
|
default DeleteBucketTaggingResponse |
deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
|
default DeleteBucketTaggingResponse |
deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
|
default DeleteJobTaggingResponse |
deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)
Removes the entire tag set from the specified S3 Batch Operations job.
|
default DeleteJobTaggingResponse |
deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
Removes the entire tag set from the specified S3 Batch Operations job.
|
default DeletePublicAccessBlockResponse |
deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an AWS account. |
default DeletePublicAccessBlockResponse |
deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an AWS account. |
default DeleteStorageLensConfigurationResponse |
deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest)
Deletes the Amazon S3 Storage Lens configuration.
|
default DeleteStorageLensConfigurationResponse |
deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest)
Deletes the Amazon S3 Storage Lens configuration.
|
default DeleteStorageLensConfigurationTaggingResponse |
deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest)
Deletes the Amazon S3 Storage Lens configuration tags.
|
default DeleteStorageLensConfigurationTaggingResponse |
deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest)
Deletes the Amazon S3 Storage Lens configuration tags.
|
default DescribeJobResponse |
describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Retrieves the configuration parameters and status for a Batch Operations job.
|
default DescribeJobResponse |
describeJob(DescribeJobRequest describeJobRequest)
Retrieves the configuration parameters and status for a Batch Operations job.
|
default GetAccessPointResponse |
getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)
Returns configuration information about the specified access point.
|
default GetAccessPointResponse |
getAccessPoint(GetAccessPointRequest getAccessPointRequest)
Returns configuration information about the specified access point.
|
default GetAccessPointConfigurationForObjectLambdaResponse |
getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest)
Returns configuration for an Object Lambda Access Point.
|
default GetAccessPointConfigurationForObjectLambdaResponse |
getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest)
Returns configuration for an Object Lambda Access Point.
|
default GetAccessPointForObjectLambdaResponse |
getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest)
Returns configuration information about the specified Object Lambda Access Point
|
default GetAccessPointForObjectLambdaResponse |
getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest)
Returns configuration information about the specified Object Lambda Access Point
|
default GetAccessPointPolicyResponse |
getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
|
default GetAccessPointPolicyResponse |
getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
|
default GetAccessPointPolicyForObjectLambdaResponse |
getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest)
Returns the resource policy for an Object Lambda Access Point.
|
default GetAccessPointPolicyForObjectLambdaResponse |
getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest)
Returns the resource policy for an Object Lambda Access Point.
|
default GetAccessPointPolicyStatusResponse |
getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access.
|
default GetAccessPointPolicyStatusResponse |
getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access.
|
default GetAccessPointPolicyStatusForObjectLambdaResponse |
getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest)
Returns the status of the resource policy associated with an Object Lambda Access Point.
|
default GetAccessPointPolicyStatusForObjectLambdaResponse |
getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest)
Returns the status of the resource policy associated with an Object Lambda Access Point.
|
default GetBucketResponse |
getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest)
Gets an Amazon S3 on Outposts bucket.
|
default GetBucketResponse |
getBucket(GetBucketRequest getBucketRequest)
Gets an Amazon S3 on Outposts bucket.
|
default GetBucketLifecycleConfigurationResponse |
getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
|
default GetBucketLifecycleConfigurationResponse |
getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
|
default GetBucketPolicyResponse |
getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
|
default GetBucketPolicyResponse |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
|
default GetBucketTaggingResponse |
getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
|
default GetBucketTaggingResponse |
getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
|
default GetJobTaggingResponse |
getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)
Returns the tags on an S3 Batch Operations job.
|
default GetJobTaggingResponse |
getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
Returns the tags on an S3 Batch Operations job.
|
default GetPublicAccessBlockResponse |
getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an AWS account. |
default GetPublicAccessBlockResponse |
getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an AWS account. |
default GetStorageLensConfigurationResponse |
getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest)
Gets the Amazon S3 Storage Lens configuration.
|
default GetStorageLensConfigurationResponse |
getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest)
Gets the Amazon S3 Storage Lens configuration.
|
default GetStorageLensConfigurationTaggingResponse |
getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest)
Gets the tags of Amazon S3 Storage Lens configuration.
|
default GetStorageLensConfigurationTaggingResponse |
getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest)
Gets the tags of Amazon S3 Storage Lens configuration.
|
default ListAccessPointsResponse |
listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListAccessPointsResponse |
listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListAccessPointsForObjectLambdaResponse |
listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)
Returns a list of the access points associated with the Object Lambda Access Point.
|
default ListAccessPointsForObjectLambdaResponse |
listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)
Returns a list of the access points associated with the Object Lambda Access Point.
|
default ListAccessPointsForObjectLambdaIterable |
listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)
Returns a list of the access points associated with the Object Lambda Access Point.
|
default ListAccessPointsForObjectLambdaIterable |
listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)
Returns a list of the access points associated with the Object Lambda Access Point.
|
default ListAccessPointsIterable |
listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListAccessPointsIterable |
listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListJobsResponse |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account
making the request.
|
default ListJobsResponse |
listJobs(ListJobsRequest listJobsRequest)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account
making the request.
|
default ListJobsIterable |
listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account
making the request.
|
default ListJobsIterable |
listJobsPaginator(ListJobsRequest listJobsRequest)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account
making the request.
|
default ListRegionalBucketsResponse |
listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
|
default ListRegionalBucketsResponse |
listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest)
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
|
default ListRegionalBucketsIterable |
listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
|
default ListRegionalBucketsIterable |
listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest)
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
|
default ListStorageLensConfigurationsResponse |
listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)
Gets a list of Amazon S3 Storage Lens configurations.
|
default ListStorageLensConfigurationsResponse |
listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)
Gets a list of Amazon S3 Storage Lens configurations.
|
default ListStorageLensConfigurationsIterable |
listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)
Gets a list of Amazon S3 Storage Lens configurations.
|
default ListStorageLensConfigurationsIterable |
listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)
Gets a list of Amazon S3 Storage Lens configurations.
|
default PutAccessPointConfigurationForObjectLambdaResponse |
putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest)
Replaces configuration for an Object Lambda Access Point.
|
default PutAccessPointConfigurationForObjectLambdaResponse |
putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest)
Replaces configuration for an Object Lambda Access Point.
|
default PutAccessPointPolicyResponse |
putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)
Associates an access policy with the specified access point.
|
default PutAccessPointPolicyResponse |
putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
Associates an access policy with the specified access point.
|
default PutAccessPointPolicyForObjectLambdaResponse |
putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest)
Creates or replaces resource policy for an Object Lambda Access Point.
|
default PutAccessPointPolicyForObjectLambdaResponse |
putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest)
Creates or replaces resource policy for an Object Lambda Access Point.
|
default PutBucketLifecycleConfigurationResponse |
putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
|
default PutBucketLifecycleConfigurationResponse |
putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
|
default PutBucketPolicyResponse |
putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
|
default PutBucketPolicyResponse |
putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
|
default PutBucketTaggingResponse |
putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
|
default PutBucketTaggingResponse |
putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
|
default PutJobTaggingResponse |
putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)
Sets the supplied tag-set on an S3 Batch Operations job.
|
default PutJobTaggingResponse |
putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
Sets the supplied tag-set on an S3 Batch Operations job.
|
default PutPublicAccessBlockResponse |
putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an AWS account. |
default PutPublicAccessBlockResponse |
putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an AWS account. |
default PutStorageLensConfigurationResponse |
putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest)
Puts an Amazon S3 Storage Lens configuration.
|
default PutStorageLensConfigurationResponse |
putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest)
Puts an Amazon S3 Storage Lens configuration.
|
default PutStorageLensConfigurationTaggingResponse |
putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest)
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
|
default PutStorageLensConfigurationTaggingResponse |
putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest)
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateJobPriorityResponse |
updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)
Updates an existing S3 Batch Operations job's priority.
|
default UpdateJobPriorityResponse |
updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)
Updates an existing S3 Batch Operations job's priority.
|
default UpdateJobStatusResponse |
updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)
Updates the status for the specified job.
|
default UpdateJobStatusResponse |
updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
Updates the status for the specified job.
|
serviceNameclosestatic final String SERVICE_NAME
static S3ControlClient create()
S3ControlClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static S3ControlClientBuilder builder()
S3ControlClient.default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service User Guide.
S3 on Outposts only supports VPC-style Access Points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only Access Points in the Amazon Simple Storage Service User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service User Guide.
S3 on Outposts only supports VPC-style Access Points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only Access Points in the Amazon Simple Storage Service User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need
to create one manually via CreateAccessPointRequest.builder()
createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon Simple Storage Service User Guide.
The following actions are related to CreateAccessPointForObjectLambda:
createAccessPointForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon Simple Storage Service User Guide.
The following actions are related to CreateAccessPointForObjectLambda:
This is a convenience which creates an instance of the CreateAccessPointForObjectLambdaRequest.Builder
avoiding the need to create one manually via CreateAccessPointForObjectLambdaRequest.builder()
createAccessPointForObjectLambdaRequest - A Consumer that will call methods on CreateAccessPointForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) throws BucketAlreadyExistsException, BucketAlreadyOwnedByYouException, AwsServiceException, SdkClientException, S3ControlException
This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon 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 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
Tags
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your API request, see the Examples section.
The following actions are related to CreateBucket for Amazon S3 on Outposts:
createBucketRequest - BucketAlreadyExistsException - The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the
AWS Outposts in this Region. Select a different name and try again.BucketAlreadyOwnedByYouException - The Outposts bucket you tried to create already exists, and you own it.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketResponse createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest) throws BucketAlreadyExistsException, BucketAlreadyOwnedByYouException, AwsServiceException, SdkClientException, S3ControlException
This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon 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 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
Tags
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your API request, see the Examples section.
The following actions are related to CreateBucket for Amazon S3 on Outposts:
This is a convenience which creates an instance of the CreateBucketRequest.Builder avoiding the need to
create one manually via CreateBucketRequest.builder()
createBucketRequest - A Consumer that will call methods on CreateBucketRequest.Builder to create a request.BucketAlreadyExistsException - The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the
AWS Outposts in this Region. Select a different name and try again.BucketAlreadyOwnedByYouException - The Outposts bucket you tried to create already exists, and you own it.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateJobResponse createJob(CreateJobRequest createJobRequest) throws TooManyRequestsException, BadRequestException, IdempotencyException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
This action creates a S3 Batch Operations job.
Related actions include:
createJobRequest - TooManyRequestsExceptionBadRequestExceptionIdempotencyExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws TooManyRequestsException, BadRequestException, IdempotencyException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
This action creates a S3 Batch Operations job.
Related actions include:
This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.TooManyRequestsExceptionBadRequestExceptionIdempotencyExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need
to create one manually via DeleteAccessPointRequest.builder()
deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the specified Object Lambda Access Point.
The following actions are related to DeleteAccessPointForObjectLambda:
deleteAccessPointForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the specified Object Lambda Access Point.
The following actions are related to DeleteAccessPointForObjectLambda:
This is a convenience which creates an instance of the DeleteAccessPointForObjectLambdaRequest.Builder
avoiding the need to create one manually via DeleteAccessPointForObjectLambdaRequest.builder()
deleteAccessPointForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointPolicyResponse deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointPolicyResponse deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the DeleteAccessPointPolicyRequest.Builder avoiding
the need to create one manually via DeleteAccessPointPolicyRequest.builder()
deleteAccessPointPolicyRequest - A Consumer that will call methods on DeleteAccessPointPolicyRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Removes the resource policy for an Object Lambda Access Point.
The following actions are related to DeleteAccessPointPolicyForObjectLambda:
deleteAccessPointPolicyForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Removes the resource policy for an Object Lambda Access Point.
The following actions are related to DeleteAccessPointPolicyForObjectLambda:
This is a convenience which creates an instance of the
DeleteAccessPointPolicyForObjectLambdaRequest.Builder avoiding the need to create one manually via
DeleteAccessPointPolicyForObjectLambdaRequest.builder()
deleteAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointPolicyForObjectLambdaRequest.Builder
to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon 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 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketResponse deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon 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 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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
This is a convenience which creates an instance of the DeleteBucketRequest.Builder avoiding the need to
create one manually via DeleteBucketRequest.builder()
deleteBucketRequest - A Consumer that will call methods on DeleteBucketRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon 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 User Guide.
To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration
action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission
to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon 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 User Guide.
To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration
action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission
to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the DeleteBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketLifecycleConfigurationRequest.builder()
deleteBucketLifecycleConfigurationRequest - A Consumer that will call methods on DeleteBucketLifecycleConfigurationRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketPolicyResponse deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon
S3 on Outposts bucket. If you are using an identity other than the root user of the 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 action. For more information, see
Using Amazon S3 on Outposts
in Amazon Simple Storage Service User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketPolicyResponse deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon
S3 on Outposts bucket. If you are using an identity other than the root user of the 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 action. For more information, see
Using Amazon S3 on Outposts
in Amazon Simple Storage Service User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the DeleteBucketPolicyRequest.Builder avoiding the
need to create one manually via DeleteBucketPolicyRequest.builder()
deleteBucketPolicyRequest - A Consumer that will call methods on DeleteBucketPolicyRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketTaggingResponse deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon 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 User Guide.
To use this action, you must have permission to perform the PutBucketTagging action. By default, the
bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketTaggingResponse deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon 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 User Guide.
To use this action, you must have permission to perform the PutBucketTagging action. By default, the
bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the DeleteBucketTaggingRequest.Builder avoiding the
need to create one manually via DeleteBucketTaggingRequest.builder()
deleteBucketTaggingRequest - A Consumer that will call methods on DeleteBucketTaggingRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteJobTaggingResponse deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException
Removes the entire tag set from the specified S3 Batch Operations job. To use 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 User Guide.
Related actions include:
deleteJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteJobTaggingResponse deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException
Removes the entire tag set from the specified S3 Batch Operations job. To use 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 User Guide.
Related actions include:
This is a convenience which creates an instance of the DeleteJobTaggingRequest.Builder avoiding the need
to create one manually via DeleteJobTaggingRequest.builder()
deleteJobTaggingRequest - A Consumer that will call methods on DeleteJobTaggingRequest.Builder to create a request.InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePublicAccessBlockResponse deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException
Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
deletePublicAccessBlockRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePublicAccessBlockResponse deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException
Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder avoiding
the need to create one manually via DeletePublicAccessBlockRequest.builder()
deletePublicAccessBlockRequest - A Consumer that will call methods on DeletePublicAccessBlockRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
deleteStorageLensConfigurationRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the DeleteStorageLensConfigurationRequest.Builder
avoiding the need to create one manually via DeleteStorageLensConfigurationRequest.builder()
deleteStorageLensConfigurationRequest - A Consumer that will call methods on DeleteStorageLensConfigurationRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
deleteStorageLensConfigurationTaggingRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the
DeleteStorageLensConfigurationTaggingRequest.Builder avoiding the need to create one manually via
DeleteStorageLensConfigurationTaggingRequest.builder()
deleteStorageLensConfigurationTaggingRequest - A Consumer that will call methods on DeleteStorageLensConfigurationTaggingRequest.Builder
to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
describeJobRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a convenience which creates an instance of the DescribeJobRequest.Builder avoiding the need to
create one manually via DescribeJobRequest.builder()
describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointResponse getAccessPoint(GetAccessPointRequest getAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointResponse getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the GetAccessPointRequest.Builder avoiding the need to
create one manually via GetAccessPointRequest.builder()
getAccessPointRequest - A Consumer that will call methods on GetAccessPointRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration for an Object Lambda Access Point.
The following actions are related to GetAccessPointConfigurationForObjectLambda:
getAccessPointConfigurationForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration for an Object Lambda Access Point.
The following actions are related to GetAccessPointConfigurationForObjectLambda:
This is a convenience which creates an instance of the
GetAccessPointConfigurationForObjectLambdaRequest.Builder avoiding the need to create one manually via
GetAccessPointConfigurationForObjectLambdaRequest.builder()
getAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on
GetAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to GetAccessPointForObjectLambda:
getAccessPointForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to GetAccessPointForObjectLambda:
This is a convenience which creates an instance of the GetAccessPointForObjectLambdaRequest.Builder
avoiding the need to create one manually via GetAccessPointForObjectLambdaRequest.builder()
getAccessPointForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyResponse getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
getAccessPointPolicyRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyResponse getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
This is a convenience which creates an instance of the GetAccessPointPolicyRequest.Builder avoiding the
need to create one manually via GetAccessPointPolicyRequest.builder()
getAccessPointPolicyRequest - A Consumer that will call methods on GetAccessPointPolicyRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the resource policy for an Object Lambda Access Point.
The following actions are related to GetAccessPointPolicyForObjectLambda:
getAccessPointPolicyForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the resource policy for an Object Lambda Access Point.
The following actions are related to GetAccessPointPolicyForObjectLambda:
This is a convenience which creates an instance of the GetAccessPointPolicyForObjectLambdaRequest.Builder
avoiding the need to create one manually via GetAccessPointPolicyForObjectLambdaRequest.builder()
getAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointPolicyForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
getAccessPointPolicyStatusRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
This is a convenience which creates an instance of the GetAccessPointPolicyStatusRequest.Builder avoiding
the need to create one manually via GetAccessPointPolicyStatusRequest.builder()
getAccessPointPolicyStatusRequest - A Consumer that will call methods on GetAccessPointPolicyStatusRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the status of the resource policy associated with an Object Lambda Access Point.
getAccessPointPolicyStatusForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns the status of the resource policy associated with an Object Lambda Access Point.
This is a convenience which creates an instance of the
GetAccessPointPolicyStatusForObjectLambdaRequest.Builder avoiding the need to create one manually via
GetAccessPointPolicyStatusForObjectLambdaRequest.builder()
getAccessPointPolicyStatusForObjectLambdaRequest - A Consumer that will call methods on
GetAccessPointPolicyStatusForObjectLambdaRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketResponse getBucket(GetBucketRequest getBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User 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 s3-outposts:GetBucket permissions on the specified Outposts bucket
and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket
owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to
the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketResponse getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User 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 s3-outposts:GetBucket permissions on the specified Outposts bucket
and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket
owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to
the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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.
This is a convenience which creates an instance of the GetBucketRequest.Builder avoiding the need to
create one manually via GetBucketRequest.builder()
getBucketRequest - A Consumer that will call methods on GetBucketRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon 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 User Guide.
To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to
others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon 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 User Guide.
To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to
others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the GetBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketLifecycleConfigurationRequest.builder()
getBucketLifecycleConfigurationRequest - A Consumer that will call methods on GetBucketLifecycleConfigurationRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketPolicyResponse getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon 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 User 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 action.
Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts
bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity
that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketPolicyResponse getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon 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 User 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 action.
Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts
bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity
that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the GetBucketPolicyRequest.Builder avoiding the need
to create one manually via GetBucketPolicyRequest.builder()
getBucketPolicyRequest - A Consumer that will call methods on GetBucketPolicyRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketTaggingResponse getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon 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 User Guide.
To use this action, you must have permission to perform the GetBucketTagging action. By default, the
bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketTaggingResponse getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon 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 User Guide.
To use this action, you must have permission to perform the GetBucketTagging action. By default, the
bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the GetBucketTaggingRequest.Builder avoiding the need
to create one manually via GetBucketTaggingRequest.builder()
getBucketTaggingRequest - A Consumer that will call methods on GetBucketTaggingRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetJobTaggingResponse getJobTagging(GetJobTaggingRequest getJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException
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 User Guide.
Related actions include:
getJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetJobTaggingResponse getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException
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 User Guide.
Related actions include:
This is a convenience which creates an instance of the GetJobTaggingRequest.Builder avoiding the need to
create one manually via GetJobTaggingRequest.builder()
getJobTaggingRequest - A Consumer that will call methods on GetJobTaggingRequest.Builder to create a request.InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPublicAccessBlockResponse getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest) throws NoSuchPublicAccessBlockConfigurationException, AwsServiceException, SdkClientException, S3ControlException
Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
getPublicAccessBlockRequest - NoSuchPublicAccessBlockConfigurationException - Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an
account that doesn't have a PublicAccessBlockConfiguration set.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPublicAccessBlockResponse getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest) throws NoSuchPublicAccessBlockConfigurationException, AwsServiceException, SdkClientException, S3ControlException
Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3
block public access.
Related actions include:
This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder avoiding the
need to create one manually via GetPublicAccessBlockRequest.builder()
getPublicAccessBlockRequest - A Consumer that will call methods on GetPublicAccessBlockRequest.Builder to create a
request.NoSuchPublicAccessBlockConfigurationException - Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an
account that doesn't have a PublicAccessBlockConfiguration set.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStorageLensConfigurationResponse getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
getStorageLensConfigurationRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStorageLensConfigurationResponse getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the GetStorageLensConfigurationRequest.Builder
avoiding the need to create one manually via GetStorageLensConfigurationRequest.builder()
getStorageLensConfigurationRequest - A Consumer that will call methods on GetStorageLensConfigurationRequest.Builder to create
a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
getStorageLensConfigurationTaggingRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the GetStorageLensConfigurationTaggingRequest.Builder
avoiding the need to create one manually via GetStorageLensConfigurationTaggingRequest.builder()
getStorageLensConfigurationTaggingRequest - A Consumer that will call methods on GetStorageLensConfigurationTaggingRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsResponse listAccessPoints(ListAccessPointsRequest listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException
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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsResponse listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException
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:
This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need
to create one manually via ListAccessPointsRequest.builder()
listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsIterable listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException
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:
This is a variant of
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
.listAccessPointsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.
listAccessPointsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsIterable listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException
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:
This is a variant of
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client
.listAccessPointsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.
This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need
to create one manually via ListAccessPointsRequest.builder()
listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000
access points per call. If there are 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.
The following actions are related to ListAccessPointsForObjectLambda:
listAccessPointsForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000
access points per call. If there are 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.
The following actions are related to ListAccessPointsForObjectLambda:
This is a convenience which creates an instance of the ListAccessPointsForObjectLambdaRequest.Builder
avoiding the need to create one manually via ListAccessPointsForObjectLambdaRequest.builder()
listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000
access points per call. If there are 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.
The following actions are related to ListAccessPointsForObjectLambda:
This is a variant of
listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client
.listAccessPointsForObjectLambdaPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation.
listAccessPointsForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000
access points per call. If there are 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.
The following actions are related to ListAccessPointsForObjectLambda:
This is a variant of
listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client
.listAccessPointsForObjectLambdaPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation.
This is a convenience which creates an instance of the ListAccessPointsForObjectLambdaRequest.Builder
avoiding the need to create one manually via ListAccessPointsForObjectLambdaRequest.builder()
listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
listJobsRequest - InvalidRequestExceptionInternalServiceExceptionInvalidNextTokenExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.InvalidRequestExceptionInternalServiceExceptionInvalidNextTokenExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.
listJobsRequest - InvalidRequestExceptionInternalServiceExceptionInvalidNextTokenExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.InvalidRequestExceptionInternalServiceExceptionInvalidNextTokenExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRegionalBucketsResponse listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your request, see the Examples section.
listRegionalBucketsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRegionalBucketsResponse listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your request, see the Examples section.
This is a convenience which creates an instance of the ListRegionalBucketsRequest.Builder avoiding the
need to create one manually via ListRegionalBucketsRequest.builder()
listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRegionalBucketsIterable listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your request, see the Examples section.
This is a variant of
listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client
.listRegionalBucketsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation.
listRegionalBucketsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRegionalBucketsIterable listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your request, see the Examples section.
This is a variant of
listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client
.listRegionalBucketsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation.
This is a convenience which creates an instance of the ListRegionalBucketsRequest.Builder avoiding the
need to create one manually via ListRegionalBucketsRequest.builder()
listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageLensConfigurationsResponse listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
listStorageLensConfigurationsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageLensConfigurationsResponse listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the ListStorageLensConfigurationsRequest.Builder
avoiding the need to create one manually via ListStorageLensConfigurationsRequest.builder()
listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a variant of
listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client
.listStorageLensConfigurationsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation.
listStorageLensConfigurationsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a variant of
listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client
.listStorageLensConfigurationsPaginator(request);
for (software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListStorageLensConfigurationsRequest.Builder
avoiding the need to create one manually via ListStorageLensConfigurationsRequest.builder()
listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Replaces configuration for an Object Lambda Access Point.
The following actions are related to PutAccessPointConfigurationForObjectLambda:
putAccessPointConfigurationForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Replaces configuration for an Object Lambda Access Point.
The following actions are related to PutAccessPointConfigurationForObjectLambda:
This is a convenience which creates an instance of the
PutAccessPointConfigurationForObjectLambdaRequest.Builder avoiding the need to create one manually via
PutAccessPointConfigurationForObjectLambdaRequest.builder()
putAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on
PutAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointPolicyResponse putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointPolicyResponse putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the PutAccessPointPolicyRequest.Builder avoiding the
need to create one manually via PutAccessPointPolicyRequest.builder()
putAccessPointPolicyRequest - A Consumer that will call methods on PutAccessPointPolicyRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon Simple Storage Service User Guide.
The following actions are related to PutAccessPointPolicyForObjectLambda:
putAccessPointPolicyForObjectLambdaRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon Simple Storage Service User Guide.
The following actions are related to PutAccessPointPolicyForObjectLambda:
This is a convenience which creates an instance of the PutAccessPointPolicyForObjectLambdaRequest.Builder
avoiding the need to create one manually via PutAccessPointPolicyForObjectLambdaRequest.builder()
putAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on PutAccessPointPolicyForObjectLambdaRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the PutBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketLifecycleConfigurationRequest.builder()
putBucketLifecycleConfigurationRequest - A Consumer that will call methods on PutBucketLifecycleConfigurationRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketPolicyResponse putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon 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 User 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 action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketPolicyResponse putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon 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 User 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 action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the PutBucketPolicyRequest.Builder avoiding the need
to create one manually via PutBucketPolicyRequest.builder()
putBucketPolicyRequest - A Consumer that will call methods on PutBucketPolicyRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketTaggingResponse putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User 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 action, you must have permissions to perform the s3-outposts:PutBucketTagging action.
The Outposts bucket owner has this permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions
to your Amazon S3 resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and 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 action is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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 - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutBucketTaggingResponse putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service User 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 action, you must have permissions to perform the s3-outposts:PutBucketTagging action.
The Outposts bucket owner has this permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions
to your Amazon S3 resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and 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 action is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request 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:
This is a convenience which creates an instance of the PutBucketTaggingRequest.Builder avoiding the need
to create one manually via PutBucketTaggingRequest.builder()
putBucketTaggingRequest - A Consumer that will call methods on PutBucketTaggingRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobTaggingResponse putJobTagging(PutJobTaggingRequest putJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, S3ControlException
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service User Guide.
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
To use this action, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
putJobTaggingRequest - InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionTooManyTagsException - Amazon S3 throws this exception if you have too many tags in your tag set.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobTaggingResponse putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, S3ControlException
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service User Guide.
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
To use this action, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
This is a convenience which creates an instance of the PutJobTaggingRequest.Builder avoiding the need to
create one manually via PutJobTaggingRequest.builder()
putJobTaggingRequest - A Consumer that will call methods on PutJobTaggingRequest.Builder to create a request.InternalServiceExceptionTooManyRequestsExceptionNotFoundExceptionTooManyTagsException - Amazon S3 throws this exception if you have too many tags in your tag set.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPublicAccessBlockResponse putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information,
see Using
Amazon S3 block public access.
Related actions include:
putPublicAccessBlockRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPublicAccessBlockResponse putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException
Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information,
see Using
Amazon S3 block public access.
Related actions include:
This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder avoiding the
need to create one manually via PutPublicAccessBlockRequest.builder()
putPublicAccessBlockRequest - A Consumer that will call methods on PutPublicAccessBlockRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutStorageLensConfigurationResponse putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
putStorageLensConfigurationRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutStorageLensConfigurationResponse putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action.
For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the PutStorageLensConfigurationRequest.Builder
avoiding the need to create one manually via PutStorageLensConfigurationRequest.builder()
putStorageLensConfigurationRequest - A Consumer that will call methods on PutStorageLensConfigurationRequest.Builder to create
a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
putStorageLensConfigurationTaggingRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging
action. For more information, see Setting permissions to
use Amazon S3 Storage Lens in the Amazon Simple Storage Service User Guide.
This is a convenience which creates an instance of the PutStorageLensConfigurationTaggingRequest.Builder
avoiding the need to create one manually via PutStorageLensConfigurationTaggingRequest.builder()
putStorageLensConfigurationTaggingRequest - A Consumer that will call methods on PutStorageLensConfigurationTaggingRequest.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateJobPriorityResponse updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
updateJobPriorityRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateJobPriorityResponse updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a convenience which creates an instance of the UpdateJobPriorityRequest.Builder avoiding the need
to create one manually via UpdateJobPriorityRequest.builder()
updateJobPriorityRequest - A Consumer that will call methods on UpdateJobPriorityRequest.Builder to create a request.BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateJobStatusResponse updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, JobStatusException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
updateJobStatusRequest - BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionJobStatusExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateJobStatusResponse updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, JobStatusException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException
Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
This is a convenience which creates an instance of the UpdateJobStatusRequest.Builder avoiding the need
to create one manually via UpdateJobStatusRequest.builder()
updateJobStatusRequest - A Consumer that will call methods on UpdateJobStatusRequest.Builder to create a request.BadRequestExceptionTooManyRequestsExceptionNotFoundExceptionJobStatusExceptionInternalServiceExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.S3ControlException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.