Interface S3ControlClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateAccessGrantsIdentityCenter
(Consumer<AssociateAccessGrantsIdentityCenterRequest.Builder> associateAccessGrantsIdentityCenterRequest) Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance.associateAccessGrantsIdentityCenter
(AssociateAccessGrantsIdentityCenterRequest associateAccessGrantsIdentityCenterRequest) Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance.static S3ControlClientBuilder
builder()
Create a builder that can be used to configure and create aS3ControlClient
.static S3ControlClient
create()
Create aS3ControlClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAccessGrantResponse
createAccessGrant
(Consumer<CreateAccessGrantRequest.Builder> createAccessGrantRequest) Creates an access grant that gives a grantee access to your S3 data.default CreateAccessGrantResponse
createAccessGrant
(CreateAccessGrantRequest createAccessGrantRequest) Creates an access grant that gives a grantee access to your S3 data.createAccessGrantsInstance
(Consumer<CreateAccessGrantsInstanceRequest.Builder> createAccessGrantsInstanceRequest) Creates an S3 Access Grants instance, which serves as a logical grouping for access grants.createAccessGrantsInstance
(CreateAccessGrantsInstanceRequest createAccessGrantsInstanceRequest) Creates an S3 Access Grants instance, which serves as a logical grouping for access grants.createAccessGrantsLocation
(Consumer<CreateAccessGrantsLocationRequest.Builder> createAccessGrantsLocationRequest) The S3 data location that you would like to register in your S3 Access Grants instance.createAccessGrantsLocation
(CreateAccessGrantsLocationRequest createAccessGrantsLocationRequest) The S3 data location that you would like to register in your S3 Access Grants instance.default CreateAccessPointResponse
createAccessPoint
(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest) default CreateAccessPointResponse
createAccessPoint
(CreateAccessPointRequest createAccessPointRequest) createAccessPointForObjectLambda
(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest) createAccessPointForObjectLambda
(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest) default CreateBucketResponse
createBucket
(Consumer<CreateBucketRequest.Builder> createBucketRequest) default CreateBucketResponse
createBucket
(CreateBucketRequest createBucketRequest) default CreateJobResponse
createJob
(Consumer<CreateJobRequest.Builder> createJobRequest) This operation creates an S3 Batch Operations job.default CreateJobResponse
createJob
(CreateJobRequest createJobRequest) This operation creates an S3 Batch Operations job.createMultiRegionAccessPoint
(Consumer<CreateMultiRegionAccessPointRequest.Builder> createMultiRegionAccessPointRequest) createMultiRegionAccessPoint
(CreateMultiRegionAccessPointRequest createMultiRegionAccessPointRequest) default CreateStorageLensGroupResponse
createStorageLensGroup
(Consumer<CreateStorageLensGroupRequest.Builder> createStorageLensGroupRequest) Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID.default CreateStorageLensGroupResponse
createStorageLensGroup
(CreateStorageLensGroupRequest createStorageLensGroupRequest) Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID.default DeleteAccessGrantResponse
deleteAccessGrant
(Consumer<DeleteAccessGrantRequest.Builder> deleteAccessGrantRequest) Deletes the access grant from the S3 Access Grants instance.default DeleteAccessGrantResponse
deleteAccessGrant
(DeleteAccessGrantRequest deleteAccessGrantRequest) Deletes the access grant from the S3 Access Grants instance.deleteAccessGrantsInstance
(Consumer<DeleteAccessGrantsInstanceRequest.Builder> deleteAccessGrantsInstanceRequest) Deletes your S3 Access Grants instance.deleteAccessGrantsInstance
(DeleteAccessGrantsInstanceRequest deleteAccessGrantsInstanceRequest) Deletes your S3 Access Grants instance.deleteAccessGrantsInstanceResourcePolicy
(Consumer<DeleteAccessGrantsInstanceResourcePolicyRequest.Builder> deleteAccessGrantsInstanceResourcePolicyRequest) Deletes the resource policy of the S3 Access Grants instance.deleteAccessGrantsInstanceResourcePolicy
(DeleteAccessGrantsInstanceResourcePolicyRequest deleteAccessGrantsInstanceResourcePolicyRequest) Deletes the resource policy of the S3 Access Grants instance.deleteAccessGrantsLocation
(Consumer<DeleteAccessGrantsLocationRequest.Builder> deleteAccessGrantsLocationRequest) Deregisters a location from your S3 Access Grants instance.deleteAccessGrantsLocation
(DeleteAccessGrantsLocationRequest deleteAccessGrantsLocationRequest) Deregisters a location from your S3 Access Grants instance.default DeleteAccessPointResponse
deleteAccessPoint
(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest) default DeleteAccessPointResponse
deleteAccessPoint
(DeleteAccessPointRequest deleteAccessPointRequest) deleteAccessPointForObjectLambda
(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest) deleteAccessPointForObjectLambda
(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest) default DeleteAccessPointPolicyResponse
deleteAccessPointPolicy
(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest) default DeleteAccessPointPolicyResponse
deleteAccessPointPolicy
(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest) deleteAccessPointPolicyForObjectLambda
(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest) deleteAccessPointPolicyForObjectLambda
(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest) default DeleteBucketResponse
deleteBucket
(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) default DeleteBucketResponse
deleteBucket
(DeleteBucketRequest deleteBucketRequest) deleteBucketLifecycleConfiguration
(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest) deleteBucketLifecycleConfiguration
(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest) default DeleteBucketPolicyResponse
deleteBucketPolicy
(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest) default DeleteBucketPolicyResponse
deleteBucketPolicy
(DeleteBucketPolicyRequest deleteBucketPolicyRequest) default DeleteBucketReplicationResponse
deleteBucketReplication
(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest) default DeleteBucketReplicationResponse
deleteBucketReplication
(DeleteBucketReplicationRequest deleteBucketReplicationRequest) default DeleteBucketTaggingResponse
deleteBucketTagging
(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest) default DeleteBucketTaggingResponse
deleteBucketTagging
(DeleteBucketTaggingRequest deleteBucketTaggingRequest) default DeleteJobTaggingResponse
deleteJobTagging
(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest) Removes the entire tag set from the specified S3 Batch Operations job.default DeleteJobTaggingResponse
deleteJobTagging
(DeleteJobTaggingRequest deleteJobTaggingRequest) Removes the entire tag set from the specified S3 Batch Operations job.deleteMultiRegionAccessPoint
(Consumer<DeleteMultiRegionAccessPointRequest.Builder> deleteMultiRegionAccessPointRequest) deleteMultiRegionAccessPoint
(DeleteMultiRegionAccessPointRequest deleteMultiRegionAccessPointRequest) default DeletePublicAccessBlockResponse
deletePublicAccessBlock
(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest) default DeletePublicAccessBlockResponse
deletePublicAccessBlock
(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) deleteStorageLensConfiguration
(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest) deleteStorageLensConfiguration
(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest) deleteStorageLensConfigurationTagging
(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest) deleteStorageLensConfigurationTagging
(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest) default DeleteStorageLensGroupResponse
deleteStorageLensGroup
(Consumer<DeleteStorageLensGroupRequest.Builder> deleteStorageLensGroupRequest) Deletes an existing S3 Storage Lens group.default DeleteStorageLensGroupResponse
deleteStorageLensGroup
(DeleteStorageLensGroupRequest deleteStorageLensGroupRequest) Deletes an existing S3 Storage Lens group.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.describeMultiRegionAccessPointOperation
(Consumer<DescribeMultiRegionAccessPointOperationRequest.Builder> describeMultiRegionAccessPointOperationRequest) describeMultiRegionAccessPointOperation
(DescribeMultiRegionAccessPointOperationRequest describeMultiRegionAccessPointOperationRequest) dissociateAccessGrantsIdentityCenter
(Consumer<DissociateAccessGrantsIdentityCenterRequest.Builder> dissociateAccessGrantsIdentityCenterRequest) Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.dissociateAccessGrantsIdentityCenter
(DissociateAccessGrantsIdentityCenterRequest dissociateAccessGrantsIdentityCenterRequest) Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.default GetAccessGrantResponse
getAccessGrant
(Consumer<GetAccessGrantRequest.Builder> getAccessGrantRequest) Get the details of an access grant from your S3 Access Grants instance.default GetAccessGrantResponse
getAccessGrant
(GetAccessGrantRequest getAccessGrantRequest) Get the details of an access grant from your S3 Access Grants instance.default GetAccessGrantsInstanceResponse
getAccessGrantsInstance
(Consumer<GetAccessGrantsInstanceRequest.Builder> getAccessGrantsInstanceRequest) Retrieves the S3 Access Grants instance for a Region in your account.default GetAccessGrantsInstanceResponse
getAccessGrantsInstance
(GetAccessGrantsInstanceRequest getAccessGrantsInstanceRequest) Retrieves the S3 Access Grants instance for a Region in your account.getAccessGrantsInstanceForPrefix
(Consumer<GetAccessGrantsInstanceForPrefixRequest.Builder> getAccessGrantsInstanceForPrefixRequest) Retrieve the S3 Access Grants instance that contains a particular prefix.getAccessGrantsInstanceForPrefix
(GetAccessGrantsInstanceForPrefixRequest getAccessGrantsInstanceForPrefixRequest) Retrieve the S3 Access Grants instance that contains a particular prefix.getAccessGrantsInstanceResourcePolicy
(Consumer<GetAccessGrantsInstanceResourcePolicyRequest.Builder> getAccessGrantsInstanceResourcePolicyRequest) Returns the resource policy of the S3 Access Grants instance.getAccessGrantsInstanceResourcePolicy
(GetAccessGrantsInstanceResourcePolicyRequest getAccessGrantsInstanceResourcePolicyRequest) Returns the resource policy of the S3 Access Grants instance.default GetAccessGrantsLocationResponse
getAccessGrantsLocation
(Consumer<GetAccessGrantsLocationRequest.Builder> getAccessGrantsLocationRequest) Retrieves the details of a particular location registered in your S3 Access Grants instance.default GetAccessGrantsLocationResponse
getAccessGrantsLocation
(GetAccessGrantsLocationRequest getAccessGrantsLocationRequest) Retrieves the details of a particular location registered in your S3 Access Grants instance.default GetAccessPointResponse
getAccessPoint
(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest) default GetAccessPointResponse
getAccessPoint
(GetAccessPointRequest getAccessPointRequest) getAccessPointConfigurationForObjectLambda
(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest) getAccessPointConfigurationForObjectLambda
(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest) getAccessPointForObjectLambda
(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest) getAccessPointForObjectLambda
(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest) default GetAccessPointPolicyResponse
getAccessPointPolicy
(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest) default GetAccessPointPolicyResponse
getAccessPointPolicy
(GetAccessPointPolicyRequest getAccessPointPolicyRequest) getAccessPointPolicyForObjectLambda
(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest) getAccessPointPolicyForObjectLambda
(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest) getAccessPointPolicyStatus
(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest) getAccessPointPolicyStatus
(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest) getAccessPointPolicyStatusForObjectLambda
(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest) getAccessPointPolicyStatusForObjectLambda
(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest) 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.getBucketLifecycleConfiguration
(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest) getBucketLifecycleConfiguration
(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) default GetBucketPolicyResponse
getBucketPolicy
(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest) default GetBucketPolicyResponse
getBucketPolicy
(GetBucketPolicyRequest getBucketPolicyRequest) default GetBucketReplicationResponse
getBucketReplication
(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest) default GetBucketReplicationResponse
getBucketReplication
(GetBucketReplicationRequest getBucketReplicationRequest) default GetBucketTaggingResponse
getBucketTagging
(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest) default GetBucketTaggingResponse
getBucketTagging
(GetBucketTaggingRequest getBucketTaggingRequest) default GetBucketVersioningResponse
getBucketVersioning
(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest) default GetBucketVersioningResponse
getBucketVersioning
(GetBucketVersioningRequest getBucketVersioningRequest) default GetDataAccessResponse
getDataAccess
(Consumer<GetDataAccessRequest.Builder> getDataAccessRequest) Returns a temporary access credential from S3 Access Grants to the grantee or client application.default GetDataAccessResponse
getDataAccess
(GetDataAccessRequest getDataAccessRequest) Returns a temporary access credential from S3 Access Grants to the grantee or client application.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.getMultiRegionAccessPoint
(Consumer<GetMultiRegionAccessPointRequest.Builder> getMultiRegionAccessPointRequest) getMultiRegionAccessPoint
(GetMultiRegionAccessPointRequest getMultiRegionAccessPointRequest) getMultiRegionAccessPointPolicy
(Consumer<GetMultiRegionAccessPointPolicyRequest.Builder> getMultiRegionAccessPointPolicyRequest) getMultiRegionAccessPointPolicy
(GetMultiRegionAccessPointPolicyRequest getMultiRegionAccessPointPolicyRequest) getMultiRegionAccessPointPolicyStatus
(Consumer<GetMultiRegionAccessPointPolicyStatusRequest.Builder> getMultiRegionAccessPointPolicyStatusRequest) getMultiRegionAccessPointPolicyStatus
(GetMultiRegionAccessPointPolicyStatusRequest getMultiRegionAccessPointPolicyStatusRequest) getMultiRegionAccessPointRoutes
(Consumer<GetMultiRegionAccessPointRoutesRequest.Builder> getMultiRegionAccessPointRoutesRequest) getMultiRegionAccessPointRoutes
(GetMultiRegionAccessPointRoutesRequest getMultiRegionAccessPointRoutesRequest) default GetPublicAccessBlockResponse
getPublicAccessBlock
(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest) default GetPublicAccessBlockResponse
getPublicAccessBlock
(GetPublicAccessBlockRequest getPublicAccessBlockRequest) getStorageLensConfiguration
(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest) getStorageLensConfiguration
(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest) getStorageLensConfigurationTagging
(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest) getStorageLensConfigurationTagging
(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest) default GetStorageLensGroupResponse
getStorageLensGroup
(Consumer<GetStorageLensGroupRequest.Builder> getStorageLensGroupRequest) Retrieves the Storage Lens group configuration details.default GetStorageLensGroupResponse
getStorageLensGroup
(GetStorageLensGroupRequest getStorageLensGroupRequest) Retrieves the Storage Lens group configuration details.default ListAccessGrantsResponse
listAccessGrants
(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) Returns the list of access grants in your S3 Access Grants instance.default ListAccessGrantsResponse
listAccessGrants
(ListAccessGrantsRequest listAccessGrantsRequest) Returns the list of access grants in your S3 Access Grants instance.listAccessGrantsInstances
(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest) Returns a list of S3 Access Grants instances.listAccessGrantsInstances
(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest) Returns a list of S3 Access Grants instances.listAccessGrantsInstancesPaginator
(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest) This is a variant oflistAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
operation.listAccessGrantsInstancesPaginator
(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest) This is a variant oflistAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
operation.listAccessGrantsLocations
(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest) Returns a list of the locations registered in your S3 Access Grants instance.listAccessGrantsLocations
(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest) Returns a list of the locations registered in your S3 Access Grants instance.listAccessGrantsLocationsPaginator
(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest) This is a variant oflistAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
operation.listAccessGrantsLocationsPaginator
(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest) This is a variant oflistAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
operation.default ListAccessGrantsIterable
listAccessGrantsPaginator
(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) This is a variant oflistAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
operation.default ListAccessGrantsIterable
listAccessGrantsPaginator
(ListAccessGrantsRequest listAccessGrantsRequest) This is a variant oflistAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
operation.default ListAccessPointsResponse
listAccessPoints
(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) default ListAccessPointsResponse
listAccessPoints
(ListAccessPointsRequest listAccessPointsRequest) listAccessPointsForObjectLambda
(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) listAccessPointsForObjectLambda
(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) listAccessPointsForObjectLambdaPaginator
(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) This is a variant oflistAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation.listAccessPointsForObjectLambdaPaginator
(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) This is a variant oflistAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation.default ListAccessPointsIterable
listAccessPointsPaginator
(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) This is a variant oflistAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest)
operation.default ListAccessPointsIterable
listAccessPointsPaginator
(ListAccessPointsRequest listAccessPointsRequest) This is a variant oflistAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest)
operation.default ListJobsResponse
listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request.default ListJobsResponse
listJobs
(ListJobsRequest listJobsRequest) Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request.default ListJobsIterable
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation.default ListJobsIterable
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation.listMultiRegionAccessPoints
(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest) listMultiRegionAccessPoints
(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest) listMultiRegionAccessPointsPaginator
(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest) This is a variant oflistMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation.listMultiRegionAccessPointsPaginator
(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest) This is a variant oflistMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation.default ListRegionalBucketsResponse
listRegionalBuckets
(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) default ListRegionalBucketsResponse
listRegionalBuckets
(ListRegionalBucketsRequest listRegionalBucketsRequest) default ListRegionalBucketsIterable
listRegionalBucketsPaginator
(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) This is a variant oflistRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation.default ListRegionalBucketsIterable
listRegionalBucketsPaginator
(ListRegionalBucketsRequest listRegionalBucketsRequest) This is a variant oflistRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation.listStorageLensConfigurations
(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) listStorageLensConfigurations
(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) listStorageLensConfigurationsPaginator
(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) This is a variant oflistStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation.listStorageLensConfigurationsPaginator
(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) This is a variant oflistStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation.default ListStorageLensGroupsResponse
listStorageLensGroups
(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest) Lists all the Storage Lens groups in the specified home Region.default ListStorageLensGroupsResponse
listStorageLensGroups
(ListStorageLensGroupsRequest listStorageLensGroupsRequest) Lists all the Storage Lens groups in the specified home Region.default ListStorageLensGroupsIterable
listStorageLensGroupsPaginator
(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest) This is a variant oflistStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
operation.default ListStorageLensGroupsIterable
listStorageLensGroupsPaginator
(ListStorageLensGroupsRequest listStorageLensGroupsRequest) This is a variant oflistStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This operation allows you to list all the Amazon Web Services resource tags for a specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) This operation allows you to list all the Amazon Web Services resource tags for a specified resource.putAccessGrantsInstanceResourcePolicy
(Consumer<PutAccessGrantsInstanceResourcePolicyRequest.Builder> putAccessGrantsInstanceResourcePolicyRequest) Updates the resource policy of the S3 Access Grants instance.putAccessGrantsInstanceResourcePolicy
(PutAccessGrantsInstanceResourcePolicyRequest putAccessGrantsInstanceResourcePolicyRequest) Updates the resource policy of the S3 Access Grants instance.putAccessPointConfigurationForObjectLambda
(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest) putAccessPointConfigurationForObjectLambda
(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest) default PutAccessPointPolicyResponse
putAccessPointPolicy
(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest) default PutAccessPointPolicyResponse
putAccessPointPolicy
(PutAccessPointPolicyRequest putAccessPointPolicyRequest) putAccessPointPolicyForObjectLambda
(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest) putAccessPointPolicyForObjectLambda
(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest) putBucketLifecycleConfiguration
(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest) putBucketLifecycleConfiguration
(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest) default PutBucketPolicyResponse
putBucketPolicy
(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest) default PutBucketPolicyResponse
putBucketPolicy
(PutBucketPolicyRequest putBucketPolicyRequest) default PutBucketReplicationResponse
putBucketReplication
(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest) default PutBucketReplicationResponse
putBucketReplication
(PutBucketReplicationRequest putBucketReplicationRequest) default PutBucketTaggingResponse
putBucketTagging
(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest) default PutBucketTaggingResponse
putBucketTagging
(PutBucketTaggingRequest putBucketTaggingRequest) default PutBucketVersioningResponse
putBucketVersioning
(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest) default PutBucketVersioningResponse
putBucketVersioning
(PutBucketVersioningRequest putBucketVersioningRequest) default PutJobTaggingResponse
putJobTagging
(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest) Sets the supplied tag-set on an S3 Batch Operations job.default PutJobTaggingResponse
putJobTagging
(PutJobTaggingRequest putJobTaggingRequest) Sets the supplied tag-set on an S3 Batch Operations job.putMultiRegionAccessPointPolicy
(Consumer<PutMultiRegionAccessPointPolicyRequest.Builder> putMultiRegionAccessPointPolicyRequest) putMultiRegionAccessPointPolicy
(PutMultiRegionAccessPointPolicyRequest putMultiRegionAccessPointPolicyRequest) default PutPublicAccessBlockResponse
putPublicAccessBlock
(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest) default PutPublicAccessBlockResponse
putPublicAccessBlock
(PutPublicAccessBlockRequest putPublicAccessBlockRequest) putStorageLensConfiguration
(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest) putStorageLensConfiguration
(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest) putStorageLensConfigurationTagging
(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest) putStorageLensConfigurationTagging
(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest) The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
submitMultiRegionAccessPointRoutes
(Consumer<SubmitMultiRegionAccessPointRoutesRequest.Builder> submitMultiRegionAccessPointRoutesRequest) submitMultiRegionAccessPointRoutes
(SubmitMultiRegionAccessPointRoutesRequest submitMultiRegionAccessPointRoutesRequest) default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates a new Amazon Web Services resource tag or updates an existing resource tag.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Creates a new Amazon Web Services resource tag or updates an existing resource tag.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) This operation removes the specified Amazon Web Services resource tags from an S3 resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) This operation removes the specified Amazon Web Services resource tags from an S3 resource.updateAccessGrantsLocation
(Consumer<UpdateAccessGrantsLocationRequest.Builder> updateAccessGrantsLocationRequest) Updates the IAM role of a registered location in your S3 Access Grants instance.updateAccessGrantsLocation
(UpdateAccessGrantsLocationRequest updateAccessGrantsLocationRequest) Updates the IAM role of a registered location in your S3 Access Grants instance.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.default UpdateStorageLensGroupResponse
updateStorageLensGroup
(Consumer<UpdateStorageLensGroupRequest.Builder> updateStorageLensGroupRequest) Updates the existing Storage Lens group.default UpdateStorageLensGroupResponse
updateStorageLensGroup
(UpdateStorageLensGroupRequest updateStorageLensGroupRequest) Updates the existing Storage Lens group.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateAccessGrantsIdentityCenter
default AssociateAccessGrantsIdentityCenterResponse associateAccessGrantsIdentityCenter(AssociateAccessGrantsIdentityCenterRequest associateAccessGrantsIdentityCenterRequest) throws AwsServiceException, SdkClientException, S3ControlException Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.
- Permissions
-
You must have the
s3:AssociateAccessGrantsIdentityCenter
permission to use this operation. - Additional Permissions
-
You must also have the following permissions:
sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
.
- Parameters:
associateAccessGrantsIdentityCenterRequest
-- Returns:
- Result of the AssociateAccessGrantsIdentityCenter operation returned by the service.
- See Also:
-
associateAccessGrantsIdentityCenter
default AssociateAccessGrantsIdentityCenterResponse associateAccessGrantsIdentityCenter(Consumer<AssociateAccessGrantsIdentityCenterRequest.Builder> associateAccessGrantsIdentityCenterRequest) throws AwsServiceException, SdkClientException, S3ControlException Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.
- Permissions
-
You must have the
s3:AssociateAccessGrantsIdentityCenter
permission to use this operation. - Additional Permissions
-
You must also have the following permissions:
sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
.
This is a convenience which creates an instance of the
AssociateAccessGrantsIdentityCenterRequest.Builder
avoiding the need to create one manually viaAssociateAccessGrantsIdentityCenterRequest.builder()
- Parameters:
associateAccessGrantsIdentityCenterRequest
- AConsumer
that will call methods onAssociateAccessGrantsIdentityCenterRequest.Builder
to create a request.- Returns:
- Result of the AssociateAccessGrantsIdentityCenter operation returned by the service.
- See Also:
-
createAccessGrant
default CreateAccessGrantResponse createAccessGrant(CreateAccessGrantRequest createAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.
- Permissions
-
You must have the
s3:CreateAccessGrant
permission to use this operation. - Additional Permissions
-
For any directory identity -
sso:DescribeInstance
andsso:DescribeApplication
For directory users -
identitystore:DescribeUser
For directory groups -
identitystore:DescribeGroup
- Parameters:
createAccessGrantRequest
-- Returns:
- Result of the CreateAccessGrant operation returned by the service.
- See Also:
-
createAccessGrant
default CreateAccessGrantResponse createAccessGrant(Consumer<CreateAccessGrantRequest.Builder> createAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.
- Permissions
-
You must have the
s3:CreateAccessGrant
permission to use this operation. - Additional Permissions
-
For any directory identity -
sso:DescribeInstance
andsso:DescribeApplication
For directory users -
identitystore:DescribeUser
For directory groups -
identitystore:DescribeGroup
This is a convenience which creates an instance of the
CreateAccessGrantRequest.Builder
avoiding the need to create one manually viaCreateAccessGrantRequest.builder()
- Parameters:
createAccessGrantRequest
- AConsumer
that will call methods onCreateAccessGrantRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessGrant operation returned by the service.
- See Also:
-
createAccessGrantsInstance
default CreateAccessGrantsInstanceResponse createAccessGrantsInstance(CreateAccessGrantsInstanceRequest createAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.
- Permissions
-
You must have the
s3:CreateAccessGrantsInstance
permission to use this operation. - Additional Permissions
-
To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the
sso:DescribeInstance
,sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
permissions.
- Parameters:
createAccessGrantsInstanceRequest
-- Returns:
- Result of the CreateAccessGrantsInstance operation returned by the service.
- See Also:
-
createAccessGrantsInstance
default CreateAccessGrantsInstanceResponse createAccessGrantsInstance(Consumer<CreateAccessGrantsInstanceRequest.Builder> createAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.
- Permissions
-
You must have the
s3:CreateAccessGrantsInstance
permission to use this operation. - Additional Permissions
-
To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the
sso:DescribeInstance
,sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
permissions.
This is a convenience which creates an instance of the
CreateAccessGrantsInstanceRequest.Builder
avoiding the need to create one manually viaCreateAccessGrantsInstanceRequest.builder()
- Parameters:
createAccessGrantsInstanceRequest
- AConsumer
that will call methods onCreateAccessGrantsInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessGrantsInstance operation returned by the service.
- See Also:
-
createAccessGrantsLocation
default CreateAccessGrantsLocationResponse createAccessGrantsLocation(CreateAccessGrantsLocationRequest createAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
-
The default S3 location
s3://
-
A bucket -
S3://<bucket-name>
-
A bucket and prefix -
S3://<bucket-name>/<prefix>
When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
- Permissions
-
You must have the
s3:CreateAccessGrantsLocation
permission to use this operation. - Additional Permissions
-
You must also have the following permission for the specified IAM role:
iam:PassRole
- Parameters:
createAccessGrantsLocationRequest
-- Returns:
- Result of the CreateAccessGrantsLocation operation returned by the service.
- See Also:
-
-
createAccessGrantsLocation
default CreateAccessGrantsLocationResponse createAccessGrantsLocation(Consumer<CreateAccessGrantsLocationRequest.Builder> createAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
-
The default S3 location
s3://
-
A bucket -
S3://<bucket-name>
-
A bucket and prefix -
S3://<bucket-name>/<prefix>
When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
- Permissions
-
You must have the
s3:CreateAccessGrantsLocation
permission to use this operation. - Additional Permissions
-
You must also have the following permission for the specified IAM role:
iam:PassRole
This is a convenience which creates an instance of the
CreateAccessGrantsLocationRequest.Builder
avoiding the need to create one manually viaCreateAccessGrantsLocationRequest.builder()
- Parameters:
createAccessGrantsLocationRequest
- AConsumer
that will call methods onCreateAccessGrantsLocationRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessGrantsLocation operation returned by the service.
- See Also:
-
-
createAccessPoint
default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
S3 on Outposts only supports VPC-style access points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
CreateAccessPoint
:- Parameters:
createAccessPointRequest
-- Returns:
- Result of the CreateAccessPoint operation returned by the service.
- See Also:
-
createAccessPoint
default CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
S3 on Outposts only supports VPC-style access points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaCreateAccessPointRequest.builder()
- Parameters:
createAccessPointRequest
- AConsumer
that will call methods onCreateAccessPointRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessPoint operation returned by the service.
- See Also:
-
createAccessPointForObjectLambda
default CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
CreateAccessPointForObjectLambda
:- Parameters:
createAccessPointForObjectLambdaRequest
-- Returns:
- Result of the CreateAccessPointForObjectLambda operation returned by the service.
- See Also:
-
createAccessPointForObjectLambda
default CreateAccessPointForObjectLambdaResponse createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
CreateAccessPointForObjectLambda
:
This is a convenience which creates an instance of the
CreateAccessPointForObjectLambdaRequest.Builder
avoiding the need to create one manually viaCreateAccessPointForObjectLambdaRequest.builder()
- Parameters:
createAccessPointForObjectLambdaRequest
- AConsumer
that will call methods onCreateAccessPointForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessPointForObjectLambda operation returned by the service.
- See Also:
-
createBucket
default CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) throws BucketAlreadyExistsException, BucketAlreadyOwnedByYouException, AwsServiceException, SdkClientException, S3ControlException This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
-
Tags
-
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your API request, see the Examples section.The following actions are related to
CreateBucket
for Amazon S3 on Outposts:- Parameters:
createBucketRequest
-- Returns:
- Result of the CreateBucket operation returned by the service.
- See Also:
-
-
createBucket
default CreateBucketResponse createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest) throws BucketAlreadyExistsException, BucketAlreadyOwnedByYouException, AwsServiceException, SdkClientException, S3ControlException This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
-
Tags
-
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your API request, see the Examples section.The following actions are related to
CreateBucket
for Amazon S3 on Outposts:
This is a convenience which creates an instance of the
CreateBucketRequest.Builder
avoiding the need to create one manually viaCreateBucketRequest.builder()
- Parameters:
createBucketRequest
- AConsumer
that will call methods onCreateBucketRequest.Builder
to create a request.- Returns:
- Result of the CreateBucket operation returned by the service.
- See Also:
-
-
createJob
default CreateJobResponse createJob(CreateJobRequest createJobRequest) throws TooManyRequestsException, BadRequestException, IdempotencyException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException This operation creates an S3 Batch Operations job.
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
- Parameters:
createJobRequest
-- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
createJob
default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws TooManyRequestsException, BadRequestException, IdempotencyException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException This operation creates an S3 Batch Operations job.
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
This is a convenience which creates an instance of the
CreateJobRequest.Builder
avoiding the need to create one manually viaCreateJobRequest.builder()
- Parameters:
createJobRequest
- AConsumer
that will call methods onCreateJobRequest.Builder
to create a request.- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
createMultiRegionAccessPoint
default CreateMultiRegionAccessPointResponse createMultiRegionAccessPoint(CreateMultiRegionAccessPointRequest createMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation
.The following actions are related to
CreateMultiRegionAccessPoint
:- Parameters:
createMultiRegionAccessPointRequest
-- Returns:
- Result of the CreateMultiRegionAccessPoint operation returned by the service.
- See Also:
-
createMultiRegionAccessPoint
default CreateMultiRegionAccessPointResponse createMultiRegionAccessPoint(Consumer<CreateMultiRegionAccessPointRequest.Builder> createMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation
.The following actions are related to
CreateMultiRegionAccessPoint
:
This is a convenience which creates an instance of the
CreateMultiRegionAccessPointRequest.Builder
avoiding the need to create one manually viaCreateMultiRegionAccessPointRequest.builder()
- Parameters:
createMultiRegionAccessPointRequest
- AConsumer
that will call methods onCreateMultiRegionAccessPointRequest.Builder
to create a request.- Returns:
- Result of the CreateMultiRegionAccessPoint operation returned by the service.
- See Also:
-
createStorageLensGroup
default CreateStorageLensGroupResponse createStorageLensGroup(CreateStorageLensGroupRequest createStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups.
To use this operation, you must have the permission to perform the
s3:CreateStorageLensGroup
action. If you’re trying to create a Storage Lens group with Amazon Web Services resource tags, you must also have permission to perform thes3:TagResource
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
- Parameters:
createStorageLensGroupRequest
-- Returns:
- Result of the CreateStorageLensGroup operation returned by the service.
- See Also:
-
createStorageLensGroup
default CreateStorageLensGroupResponse createStorageLensGroup(Consumer<CreateStorageLensGroupRequest.Builder> createStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups.
To use this operation, you must have the permission to perform the
s3:CreateStorageLensGroup
action. If you’re trying to create a Storage Lens group with Amazon Web Services resource tags, you must also have permission to perform thes3:TagResource
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
This is a convenience which creates an instance of the
CreateStorageLensGroupRequest.Builder
avoiding the need to create one manually viaCreateStorageLensGroupRequest.builder()
- Parameters:
createStorageLensGroupRequest
- AConsumer
that will call methods onCreateStorageLensGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateStorageLensGroup operation returned by the service.
- See Also:
-
deleteAccessGrant
default DeleteAccessGrantResponse deleteAccessGrant(DeleteAccessGrantRequest deleteAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.
- Permissions
-
You must have the
s3:DeleteAccessGrant
permission to use this operation.
- Parameters:
deleteAccessGrantRequest
-- Returns:
- Result of the DeleteAccessGrant operation returned by the service.
- See Also:
-
deleteAccessGrant
default DeleteAccessGrantResponse deleteAccessGrant(Consumer<DeleteAccessGrantRequest.Builder> deleteAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.
- Permissions
-
You must have the
s3:DeleteAccessGrant
permission to use this operation.
This is a convenience which creates an instance of the
DeleteAccessGrantRequest.Builder
avoiding the need to create one manually viaDeleteAccessGrantRequest.builder()
- Parameters:
deleteAccessGrantRequest
- AConsumer
that will call methods onDeleteAccessGrantRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessGrant operation returned by the service.
- See Also:
-
deleteAccessGrantsInstance
default DeleteAccessGrantsInstanceResponse deleteAccessGrantsInstance(DeleteAccessGrantsInstanceRequest deleteAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.
- Permissions
-
You must have the
s3:DeleteAccessGrantsInstance
permission to use this operation.
- Parameters:
deleteAccessGrantsInstanceRequest
-- Returns:
- Result of the DeleteAccessGrantsInstance operation returned by the service.
- See Also:
-
deleteAccessGrantsInstance
default DeleteAccessGrantsInstanceResponse deleteAccessGrantsInstance(Consumer<DeleteAccessGrantsInstanceRequest.Builder> deleteAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.
- Permissions
-
You must have the
s3:DeleteAccessGrantsInstance
permission to use this operation.
This is a convenience which creates an instance of the
DeleteAccessGrantsInstanceRequest.Builder
avoiding the need to create one manually viaDeleteAccessGrantsInstanceRequest.builder()
- Parameters:
deleteAccessGrantsInstanceRequest
- AConsumer
that will call methods onDeleteAccessGrantsInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessGrantsInstance operation returned by the service.
- See Also:
-
deleteAccessGrantsInstanceResourcePolicy
default DeleteAccessGrantsInstanceResourcePolicyResponse deleteAccessGrantsInstanceResourcePolicy(DeleteAccessGrantsInstanceResourcePolicyRequest deleteAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.
- Permissions
-
You must have the
s3:DeleteAccessGrantsInstanceResourcePolicy
permission to use this operation.
- Parameters:
deleteAccessGrantsInstanceResourcePolicyRequest
-- Returns:
- Result of the DeleteAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
deleteAccessGrantsInstanceResourcePolicy
default DeleteAccessGrantsInstanceResourcePolicyResponse deleteAccessGrantsInstanceResourcePolicy(Consumer<DeleteAccessGrantsInstanceResourcePolicyRequest.Builder> deleteAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.
- Permissions
-
You must have the
s3:DeleteAccessGrantsInstanceResourcePolicy
permission to use this operation.
This is a convenience which creates an instance of the
DeleteAccessGrantsInstanceResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteAccessGrantsInstanceResourcePolicyRequest.builder()
- Parameters:
deleteAccessGrantsInstanceResourcePolicyRequest
- AConsumer
that will call methods onDeleteAccessGrantsInstanceResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
deleteAccessGrantsLocation
default DeleteAccessGrantsLocationResponse deleteAccessGrantsLocation(DeleteAccessGrantsLocationRequest deleteAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.
- Permissions
-
You must have the
s3:DeleteAccessGrantsLocation
permission to use this operation.
- Parameters:
deleteAccessGrantsLocationRequest
-- Returns:
- Result of the DeleteAccessGrantsLocation operation returned by the service.
- See Also:
-
deleteAccessGrantsLocation
default DeleteAccessGrantsLocationResponse deleteAccessGrantsLocation(Consumer<DeleteAccessGrantsLocationRequest.Builder> deleteAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.
- Permissions
-
You must have the
s3:DeleteAccessGrantsLocation
permission to use this operation.
This is a convenience which creates an instance of the
DeleteAccessGrantsLocationRequest.Builder
avoiding the need to create one manually viaDeleteAccessGrantsLocationRequest.builder()
- Parameters:
deleteAccessGrantsLocationRequest
- AConsumer
that will call methods onDeleteAccessGrantsLocationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessGrantsLocation operation returned by the service.
- See Also:
-
deleteAccessPoint
default DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
DeleteAccessPoint
:- Parameters:
deleteAccessPointRequest
-- Returns:
- Result of the DeleteAccessPoint operation returned by the service.
- See Also:
-
deleteAccessPoint
default DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaDeleteAccessPointRequest.builder()
- Parameters:
deleteAccessPointRequest
- AConsumer
that will call methods onDeleteAccessPointRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessPoint operation returned by the service.
- See Also:
-
deleteAccessPointForObjectLambda
default DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the specified Object Lambda Access Point.
The following actions are related to
DeleteAccessPointForObjectLambda
:- Parameters:
deleteAccessPointForObjectLambdaRequest
-- Returns:
- Result of the DeleteAccessPointForObjectLambda operation returned by the service.
- See Also:
-
deleteAccessPointForObjectLambda
default DeleteAccessPointForObjectLambdaResponse deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaDeleteAccessPointForObjectLambdaRequest.builder()
- Parameters:
deleteAccessPointForObjectLambdaRequest
- AConsumer
that will call methods onDeleteAccessPointForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessPointForObjectLambda operation returned by the service.
- See Also:
-
deleteAccessPointPolicy
default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
DeleteAccessPointPolicy
:- Parameters:
deleteAccessPointPolicyRequest
-- Returns:
- Result of the DeleteAccessPointPolicy operation returned by the service.
- See Also:
-
deleteAccessPointPolicy
default DeleteAccessPointPolicyResponse deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaDeleteAccessPointPolicyRequest.builder()
- Parameters:
deleteAccessPointPolicyRequest
- AConsumer
that will call methods onDeleteAccessPointPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessPointPolicy operation returned by the service.
- See Also:
-
deleteAccessPointPolicyForObjectLambda
default DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Removes the resource policy for an Object Lambda Access Point.
The following actions are related to
DeleteAccessPointPolicyForObjectLambda
:- Parameters:
deleteAccessPointPolicyForObjectLambdaRequest
-- Returns:
- Result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
deleteAccessPointPolicyForObjectLambda
default DeleteAccessPointPolicyForObjectLambdaResponse deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaDeleteAccessPointPolicyForObjectLambdaRequest.builder()
- Parameters:
deleteAccessPointPolicyForObjectLambdaRequest
- AConsumer
that will call methods onDeleteAccessPointPolicyForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
deleteBucket
default DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.Related Resources
- Parameters:
deleteBucketRequest
-- Returns:
- Result of the DeleteBucket operation returned by the service.
- See Also:
-
deleteBucket
default DeleteBucketResponse deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaDeleteBucketRequest.builder()
- Parameters:
deleteBucketRequest
- AConsumer
that will call methods onDeleteBucketRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucket operation returned by the service.
- See Also:
-
deleteBucketLifecycleConfiguration
default DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this operation, you must have permission to perform the
s3-outposts:PutLifecycleConfiguration
action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
- Parameters:
deleteBucketLifecycleConfigurationRequest
-- Returns:
- Result of the DeleteBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
deleteBucketLifecycleConfiguration
default DeleteBucketLifecycleConfigurationResponse deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this operation, you must have permission to perform the
s3-outposts:PutLifecycleConfiguration
action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
This is a convenience which creates an instance of the
DeleteBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteBucketLifecycleConfigurationRequest.builder()
- Parameters:
deleteBucketLifecycleConfigurationRequest
- AConsumer
that will call methods onDeleteBucketLifecycleConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
deleteBucketPolicy
default DeleteBucketPolicyResponse deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
s3-outposts:DeleteBucketPolicy
permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.If you don't have
DeleteBucketPolicy
permissions, Amazon S3 returns a403 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 a405 Method Not Allowed
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
DeleteBucketPolicy
:- Parameters:
deleteBucketPolicyRequest
-- Returns:
- Result of the DeleteBucketPolicy operation returned by the service.
- See Also:
-
deleteBucketPolicy
default DeleteBucketPolicyResponse deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
s3-outposts:DeleteBucketPolicy
permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.If you don't have
DeleteBucketPolicy
permissions, Amazon S3 returns a403 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 a405 Method Not Allowed
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaDeleteBucketPolicyRequest.builder()
- Parameters:
deleteBucketPolicyRequest
- AConsumer
that will call methods onDeleteBucketPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucketPolicy operation returned by the service.
- See Also:
-
deleteBucketReplication
default DeleteBucketReplicationResponse deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.
Deletes the replication configuration from the specified S3 on Outposts bucket.
To use this operation, you must have permissions to perform the
s3-outposts:PutReplicationConfiguration
action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets in the Amazon S3 User Guide.It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
The following operations are related to
DeleteBucketReplication
:- Parameters:
deleteBucketReplicationRequest
-- Returns:
- Result of the DeleteBucketReplication operation returned by the service.
- See Also:
-
deleteBucketReplication
default DeleteBucketReplicationResponse deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.
Deletes the replication configuration from the specified S3 on Outposts bucket.
To use this operation, you must have permissions to perform the
s3-outposts:PutReplicationConfiguration
action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets in the Amazon S3 User Guide.It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
The following operations are related to
DeleteBucketReplication
:
This is a convenience which creates an instance of the
DeleteBucketReplicationRequest.Builder
avoiding the need to create one manually viaDeleteBucketReplicationRequest.builder()
- Parameters:
deleteBucketReplicationRequest
- AConsumer
that will call methods onDeleteBucketReplicationRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucketReplication operation returned by the service.
- See Also:
-
deleteBucketTagging
default DeleteBucketTaggingResponse deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the
PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
DeleteBucketTagging
:- Parameters:
deleteBucketTaggingRequest
-- Returns:
- Result of the DeleteBucketTagging operation returned by the service.
- See Also:
-
deleteBucketTagging
default DeleteBucketTaggingResponse deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the
PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaDeleteBucketTaggingRequest.builder()
- Parameters:
deleteBucketTaggingRequest
- AConsumer
that will call methods onDeleteBucketTaggingRequest.Builder
to create a request.- Returns:
- Result of the DeleteBucketTagging operation returned by the service.
- See Also:
-
deleteJobTagging
default DeleteJobTaggingResponse deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException Removes the entire tag set from the specified S3 Batch Operations job.
- Permissions
-
To use the
DeleteJobTagging
operation, you must have permission to perform thes3:DeleteJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
- Parameters:
deleteJobTaggingRequest
-- Returns:
- Result of the DeleteJobTagging operation returned by the service.
- See Also:
-
deleteJobTagging
default DeleteJobTaggingResponse deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException Removes the entire tag set from the specified S3 Batch Operations job.
- Permissions
-
To use the
DeleteJobTagging
operation, you must have permission to perform thes3:DeleteJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
This is a convenience which creates an instance of the
DeleteJobTaggingRequest.Builder
avoiding the need to create one manually viaDeleteJobTaggingRequest.builder()
- Parameters:
deleteJobTaggingRequest
- AConsumer
that will call methods onDeleteJobTaggingRequest.Builder
to create a request.- Returns:
- Result of the DeleteJobTagging operation returned by the service.
- See Also:
-
deleteMultiRegionAccessPoint
default DeleteMultiRegionAccessPointResponse deleteMultiRegionAccessPoint(DeleteMultiRegionAccessPointRequest deleteMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation
.The following actions are related to
DeleteMultiRegionAccessPoint
:- Parameters:
deleteMultiRegionAccessPointRequest
-- Returns:
- Result of the DeleteMultiRegionAccessPoint operation returned by the service.
- See Also:
-
deleteMultiRegionAccessPoint
default DeleteMultiRegionAccessPointResponse deleteMultiRegionAccessPoint(Consumer<DeleteMultiRegionAccessPointRequest.Builder> deleteMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation
.The following actions are related to
DeleteMultiRegionAccessPoint
:
This is a convenience which creates an instance of the
DeleteMultiRegionAccessPointRequest.Builder
avoiding the need to create one manually viaDeleteMultiRegionAccessPointRequest.builder()
- Parameters:
deleteMultiRegionAccessPointRequest
- AConsumer
that will call methods onDeleteMultiRegionAccessPointRequest.Builder
to create a request.- Returns:
- Result of the DeleteMultiRegionAccessPoint operation returned by the service.
- See Also:
-
deletePublicAccessBlock
default DeletePublicAccessBlockResponse deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Removes the
PublicAccessBlock
configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.Related actions include:
- Parameters:
deletePublicAccessBlockRequest
-- Returns:
- Result of the DeletePublicAccessBlock operation returned by the service.
- See Also:
-
deletePublicAccessBlock
default DeletePublicAccessBlockResponse deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Removes the
PublicAccessBlock
configuration for an Amazon Web Services 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 viaDeletePublicAccessBlockRequest.builder()
- Parameters:
deletePublicAccessBlockRequest
- AConsumer
that will call methods onDeletePublicAccessBlockRequest.Builder
to create a request.- Returns:
- Result of the DeletePublicAccessBlock operation returned by the service.
- See Also:
-
deleteStorageLensConfiguration
default DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:DeleteStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
deleteStorageLensConfigurationRequest
-- Returns:
- Result of the DeleteStorageLensConfiguration operation returned by the service.
- See Also:
-
deleteStorageLensConfiguration
default DeleteStorageLensConfigurationResponse deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:DeleteStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
DeleteStorageLensConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteStorageLensConfigurationRequest.builder()
- Parameters:
deleteStorageLensConfigurationRequest
- AConsumer
that will call methods onDeleteStorageLensConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteStorageLensConfiguration operation returned by the service.
- See Also:
-
deleteStorageLensConfigurationTagging
default DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
deleteStorageLensConfigurationTaggingRequest
-- Returns:
- Result of the DeleteStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
deleteStorageLensConfigurationTagging
default DeleteStorageLensConfigurationTaggingResponse deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
DeleteStorageLensConfigurationTaggingRequest.Builder
avoiding the need to create one manually viaDeleteStorageLensConfigurationTaggingRequest.builder()
- Parameters:
deleteStorageLensConfigurationTaggingRequest
- AConsumer
that will call methods onDeleteStorageLensConfigurationTaggingRequest.Builder
to create a request.- Returns:
- Result of the DeleteStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
deleteStorageLensGroup
default DeleteStorageLensGroupResponse deleteStorageLensGroup(DeleteStorageLensGroupRequest deleteStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes an existing S3 Storage Lens group.
To use this operation, you must have the permission to perform the
s3:DeleteStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
- Parameters:
deleteStorageLensGroupRequest
-- Returns:
- Result of the DeleteStorageLensGroup operation returned by the service.
- See Also:
-
deleteStorageLensGroup
default DeleteStorageLensGroupResponse deleteStorageLensGroup(Consumer<DeleteStorageLensGroupRequest.Builder> deleteStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Deletes an existing S3 Storage Lens group.
To use this operation, you must have the permission to perform the
s3:DeleteStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
This is a convenience which creates an instance of the
DeleteStorageLensGroupRequest.Builder
avoiding the need to create one manually viaDeleteStorageLensGroupRequest.builder()
- Parameters:
deleteStorageLensGroupRequest
- AConsumer
that will call methods onDeleteStorageLensGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteStorageLensGroup operation returned by the service.
- See Also:
-
describeJob
default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
DescribeJob
operation, you must have permission to perform thes3:DescribeJob
action.
Related actions include:
- Parameters:
describeJobRequest
-- Returns:
- Result of the DescribeJob operation returned by the service.
- See Also:
-
describeJob
default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
DescribeJob
operation, you must have permission to perform thes3:DescribeJob
action.
Related actions include:
This is a convenience which creates an instance of the
DescribeJobRequest.Builder
avoiding the need to create one manually viaDescribeJobRequest.builder()
- Parameters:
describeJobRequest
- AConsumer
that will call methods onDescribeJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeJob operation returned by the service.
- See Also:
-
describeMultiRegionAccessPointOperation
default DescribeMultiRegionAccessPointOperationResponse describeMultiRegionAccessPointOperation(DescribeMultiRegionAccessPointOperationRequest describeMultiRegionAccessPointOperationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPoint
:- Parameters:
describeMultiRegionAccessPointOperationRequest
-- Returns:
- Result of the DescribeMultiRegionAccessPointOperation operation returned by the service.
- See Also:
-
describeMultiRegionAccessPointOperation
default DescribeMultiRegionAccessPointOperationResponse describeMultiRegionAccessPointOperation(Consumer<DescribeMultiRegionAccessPointOperationRequest.Builder> describeMultiRegionAccessPointOperationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPoint
:
This is a convenience which creates an instance of the
DescribeMultiRegionAccessPointOperationRequest.Builder
avoiding the need to create one manually viaDescribeMultiRegionAccessPointOperationRequest.builder()
- Parameters:
describeMultiRegionAccessPointOperationRequest
- AConsumer
that will call methods onDescribeMultiRegionAccessPointOperationRequest.Builder
to create a request.- Returns:
- Result of the DescribeMultiRegionAccessPointOperation operation returned by the service.
- See Also:
-
dissociateAccessGrantsIdentityCenter
default DissociateAccessGrantsIdentityCenterResponse dissociateAccessGrantsIdentityCenter(DissociateAccessGrantsIdentityCenterRequest dissociateAccessGrantsIdentityCenterRequest) throws AwsServiceException, SdkClientException, S3ControlException Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
- Permissions
-
You must have the
s3:DissociateAccessGrantsIdentityCenter
permission to use this operation. - Additional Permissions
-
You must have the
sso:DeleteApplication
permission to use this operation.
- Parameters:
dissociateAccessGrantsIdentityCenterRequest
-- Returns:
- Result of the DissociateAccessGrantsIdentityCenter operation returned by the service.
- See Also:
-
dissociateAccessGrantsIdentityCenter
default DissociateAccessGrantsIdentityCenterResponse dissociateAccessGrantsIdentityCenter(Consumer<DissociateAccessGrantsIdentityCenterRequest.Builder> dissociateAccessGrantsIdentityCenterRequest) throws AwsServiceException, SdkClientException, S3ControlException Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
- Permissions
-
You must have the
s3:DissociateAccessGrantsIdentityCenter
permission to use this operation. - Additional Permissions
-
You must have the
sso:DeleteApplication
permission to use this operation.
This is a convenience which creates an instance of the
DissociateAccessGrantsIdentityCenterRequest.Builder
avoiding the need to create one manually viaDissociateAccessGrantsIdentityCenterRequest.builder()
- Parameters:
dissociateAccessGrantsIdentityCenterRequest
- AConsumer
that will call methods onDissociateAccessGrantsIdentityCenterRequest.Builder
to create a request.- Returns:
- Result of the DissociateAccessGrantsIdentityCenter operation returned by the service.
- See Also:
-
getAccessGrant
default GetAccessGrantResponse getAccessGrant(GetAccessGrantRequest getAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Get the details of an access grant from your S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrant
permission to use this operation.
- Parameters:
getAccessGrantRequest
-- Returns:
- Result of the GetAccessGrant operation returned by the service.
- See Also:
-
getAccessGrant
default GetAccessGrantResponse getAccessGrant(Consumer<GetAccessGrantRequest.Builder> getAccessGrantRequest) throws AwsServiceException, SdkClientException, S3ControlException Get the details of an access grant from your S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrant
permission to use this operation.
This is a convenience which creates an instance of the
GetAccessGrantRequest.Builder
avoiding the need to create one manually viaGetAccessGrantRequest.builder()
- Parameters:
getAccessGrantRequest
- AConsumer
that will call methods onGetAccessGrantRequest.Builder
to create a request.- Returns:
- Result of the GetAccessGrant operation returned by the service.
- See Also:
-
getAccessGrantsInstance
default GetAccessGrantsInstanceResponse getAccessGrantsInstance(GetAccessGrantsInstanceRequest getAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the S3 Access Grants instance for a Region in your account.
- Permissions
-
You must have the
s3:GetAccessGrantsInstance
permission to use this operation.
- Parameters:
getAccessGrantsInstanceRequest
-- Returns:
- Result of the GetAccessGrantsInstance operation returned by the service.
- See Also:
-
getAccessGrantsInstance
default GetAccessGrantsInstanceResponse getAccessGrantsInstance(Consumer<GetAccessGrantsInstanceRequest.Builder> getAccessGrantsInstanceRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the S3 Access Grants instance for a Region in your account.
- Permissions
-
You must have the
s3:GetAccessGrantsInstance
permission to use this operation.
This is a convenience which creates an instance of the
GetAccessGrantsInstanceRequest.Builder
avoiding the need to create one manually viaGetAccessGrantsInstanceRequest.builder()
- Parameters:
getAccessGrantsInstanceRequest
- AConsumer
that will call methods onGetAccessGrantsInstanceRequest.Builder
to create a request.- Returns:
- Result of the GetAccessGrantsInstance operation returned by the service.
- See Also:
-
getAccessGrantsInstanceForPrefix
default GetAccessGrantsInstanceForPrefixResponse getAccessGrantsInstanceForPrefix(GetAccessGrantsInstanceForPrefixRequest getAccessGrantsInstanceForPrefixRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieve the S3 Access Grants instance that contains a particular prefix.
- Permissions
-
You must have the
s3:GetAccessGrantsInstanceForPrefix
permission for the caller account to use this operation. - Additional Permissions
-
The prefix owner account must grant you the following permissions to their S3 Access Grants instance:
s3:GetAccessGrantsInstanceForPrefix
.
- Parameters:
getAccessGrantsInstanceForPrefixRequest
-- Returns:
- Result of the GetAccessGrantsInstanceForPrefix operation returned by the service.
- See Also:
-
getAccessGrantsInstanceForPrefix
default GetAccessGrantsInstanceForPrefixResponse getAccessGrantsInstanceForPrefix(Consumer<GetAccessGrantsInstanceForPrefixRequest.Builder> getAccessGrantsInstanceForPrefixRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieve the S3 Access Grants instance that contains a particular prefix.
- Permissions
-
You must have the
s3:GetAccessGrantsInstanceForPrefix
permission for the caller account to use this operation. - Additional Permissions
-
The prefix owner account must grant you the following permissions to their S3 Access Grants instance:
s3:GetAccessGrantsInstanceForPrefix
.
This is a convenience which creates an instance of the
GetAccessGrantsInstanceForPrefixRequest.Builder
avoiding the need to create one manually viaGetAccessGrantsInstanceForPrefixRequest.builder()
- Parameters:
getAccessGrantsInstanceForPrefixRequest
- AConsumer
that will call methods onGetAccessGrantsInstanceForPrefixRequest.Builder
to create a request.- Returns:
- Result of the GetAccessGrantsInstanceForPrefix operation returned by the service.
- See Also:
-
getAccessGrantsInstanceResourcePolicy
default GetAccessGrantsInstanceResourcePolicyResponse getAccessGrantsInstanceResourcePolicy(GetAccessGrantsInstanceResourcePolicyRequest getAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns the resource policy of the S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrantsInstanceResourcePolicy
permission to use this operation.
- Parameters:
getAccessGrantsInstanceResourcePolicyRequest
-- Returns:
- Result of the GetAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
getAccessGrantsInstanceResourcePolicy
default GetAccessGrantsInstanceResourcePolicyResponse getAccessGrantsInstanceResourcePolicy(Consumer<GetAccessGrantsInstanceResourcePolicyRequest.Builder> getAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns the resource policy of the S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrantsInstanceResourcePolicy
permission to use this operation.
This is a convenience which creates an instance of the
GetAccessGrantsInstanceResourcePolicyRequest.Builder
avoiding the need to create one manually viaGetAccessGrantsInstanceResourcePolicyRequest.builder()
- Parameters:
getAccessGrantsInstanceResourcePolicyRequest
- AConsumer
that will call methods onGetAccessGrantsInstanceResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the GetAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
getAccessGrantsLocation
default GetAccessGrantsLocationResponse getAccessGrantsLocation(GetAccessGrantsLocationRequest getAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the details of a particular location registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrantsLocation
permission to use this operation.
- Parameters:
getAccessGrantsLocationRequest
-- Returns:
- Result of the GetAccessGrantsLocation operation returned by the service.
- See Also:
-
getAccessGrantsLocation
default GetAccessGrantsLocationResponse getAccessGrantsLocation(Consumer<GetAccessGrantsLocationRequest.Builder> getAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the details of a particular location registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrantsLocation
permission to use this operation.
This is a convenience which creates an instance of the
GetAccessGrantsLocationRequest.Builder
avoiding the need to create one manually viaGetAccessGrantsLocationRequest.builder()
- Parameters:
getAccessGrantsLocationRequest
- AConsumer
that will call methods onGetAccessGrantsLocationRequest.Builder
to create a request.- Returns:
- Result of the GetAccessGrantsLocation operation returned by the service.
- See Also:
-
getAccessPoint
default GetAccessPointResponse getAccessPoint(GetAccessPointRequest getAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
GetAccessPoint
:- Parameters:
getAccessPointRequest
-- Returns:
- Result of the GetAccessPoint operation returned by the service.
- See Also:
-
getAccessPoint
default GetAccessPointResponse getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaGetAccessPointRequest.builder()
- Parameters:
getAccessPointRequest
- AConsumer
that will call methods onGetAccessPointRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPoint operation returned by the service.
- See Also:
-
getAccessPointConfigurationForObjectLambda
default GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration for an Object Lambda Access Point.
The following actions are related to
GetAccessPointConfigurationForObjectLambda
:- Parameters:
getAccessPointConfigurationForObjectLambdaRequest
-- Returns:
- Result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointConfigurationForObjectLambda
default GetAccessPointConfigurationForObjectLambdaResponse getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaGetAccessPointConfigurationForObjectLambdaRequest.builder()
- Parameters:
getAccessPointConfigurationForObjectLambdaRequest
- AConsumer
that will call methods onGetAccessPointConfigurationForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointForObjectLambda
default GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to
GetAccessPointForObjectLambda
:- Parameters:
getAccessPointForObjectLambdaRequest
-- Returns:
- Result of the GetAccessPointForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointForObjectLambda
default GetAccessPointForObjectLambdaResponse getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaGetAccessPointForObjectLambdaRequest.builder()
- Parameters:
getAccessPointForObjectLambdaRequest
- AConsumer
that will call methods onGetAccessPointForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointPolicy
default GetAccessPointPolicyResponse getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the access point policy associated with the specified access point.
The following actions are related to
GetAccessPointPolicy
:- Parameters:
getAccessPointPolicyRequest
-- Returns:
- Result of the GetAccessPointPolicy operation returned by the service.
- See Also:
-
getAccessPointPolicy
default GetAccessPointPolicyResponse getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaGetAccessPointPolicyRequest.builder()
- Parameters:
getAccessPointPolicyRequest
- AConsumer
that will call methods onGetAccessPointPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointPolicy operation returned by the service.
- See Also:
-
getAccessPointPolicyForObjectLambda
default GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the resource policy for an Object Lambda Access Point.
The following actions are related to
GetAccessPointPolicyForObjectLambda
:- Parameters:
getAccessPointPolicyForObjectLambdaRequest
-- Returns:
- Result of the GetAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointPolicyForObjectLambda
default GetAccessPointPolicyForObjectLambdaResponse getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaGetAccessPointPolicyForObjectLambdaRequest.builder()
- Parameters:
getAccessPointPolicyForObjectLambdaRequest
- AConsumer
that will call methods onGetAccessPointPolicyForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointPolicyStatus
default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.
- Parameters:
getAccessPointPolicyStatusRequest
-- Returns:
- Result of the GetAccessPointPolicyStatus operation returned by the service.
- See Also:
-
getAccessPointPolicyStatus
default GetAccessPointPolicyStatusResponse getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
GetAccessPointPolicyStatusRequest.Builder
avoiding the need to create one manually viaGetAccessPointPolicyStatusRequest.builder()
- Parameters:
getAccessPointPolicyStatusRequest
- AConsumer
that will call methods onGetAccessPointPolicyStatusRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointPolicyStatus operation returned by the service.
- See Also:
-
getAccessPointPolicyStatusForObjectLambda
default GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the status of the resource policy associated with an Object Lambda Access Point.
- Parameters:
getAccessPointPolicyStatusForObjectLambdaRequest
-- Returns:
- Result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.
- See Also:
-
getAccessPointPolicyStatusForObjectLambda
default GetAccessPointPolicyStatusForObjectLambdaResponse getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaGetAccessPointPolicyStatusForObjectLambdaRequest.builder()
- Parameters:
getAccessPointPolicyStatusForObjectLambdaRequest
- AConsumer
that will call methods onGetAccessPointPolicyStatusForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.
- See Also:
-
getBucket
default GetBucketResponse getBucket(GetBucketRequest getBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the
s3-outposts:GetBucket
permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.If you don't have
s3-outposts:GetBucket
permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a403 Access Denied
error.The following actions are related to
GetBucket
for Amazon S3 on Outposts:All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.- Parameters:
getBucketRequest
-- Returns:
- Result of the GetBucket operation returned by the service.
- See Also:
-
getBucket
default GetBucketResponse getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest) throws AwsServiceException, SdkClientException, S3ControlException Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the
s3-outposts:GetBucket
permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.If you don't have
s3-outposts:GetBucket
permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a403 Access Denied
error.The following actions are related to
GetBucket
for Amazon S3 on Outposts:All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaGetBucketRequest.builder()
- Parameters:
getBucketRequest
- AConsumer
that will call methods onGetBucketRequest.Builder
to create a request.- Returns:
- Result of the GetBucket operation returned by the service.
- See Also:
-
getBucketLifecycleConfiguration
default GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.GetBucketLifecycleConfiguration
has the following special error:-
Error code:
NoSuchLifecycleConfiguration
-
Description: The lifecycle configuration does not exist.
-
HTTP Status Code: 404 Not Found
-
SOAP Fault Code Prefix: Client
-
The following actions are related to
GetBucketLifecycleConfiguration
:- Parameters:
getBucketLifecycleConfigurationRequest
-- Returns:
- Result of the GetBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
-
getBucketLifecycleConfiguration
default GetBucketLifecycleConfigurationResponse getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.GetBucketLifecycleConfiguration
has the following special error:-
Error code:
NoSuchLifecycleConfiguration
-
Description: The lifecycle configuration does not exist.
-
HTTP Status Code: 404 Not Found
-
SOAP Fault Code Prefix: Client
-
The following actions are related to
GetBucketLifecycleConfiguration
:
This is a convenience which creates an instance of the
GetBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually viaGetBucketLifecycleConfigurationRequest.builder()
- Parameters:
getBucketLifecycleConfigurationRequest
- AConsumer
that will call methods onGetBucketLifecycleConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
-
getBucketPolicy
default GetBucketPolicyResponse getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
GetBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this action.Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have
s3-outposts:GetBucketPolicy
permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a403 Access Denied
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
GetBucketPolicy
:- Parameters:
getBucketPolicyRequest
-- Returns:
- Result of the GetBucketPolicy operation returned by the service.
- See Also:
-
getBucketPolicy
default GetBucketPolicyResponse getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
GetBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this action.Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have
s3-outposts:GetBucketPolicy
permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a403 Access Denied
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaGetBucketPolicyRequest.builder()
- Parameters:
getBucketPolicyRequest
- AConsumer
that will call methods onGetBucketPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetBucketPolicy operation returned by the service.
- See Also:
-
getBucketReplication
default GetBucketReplicationResponse getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.
Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.This action requires permissions for the
s3-outposts:GetReplicationConfiguration
action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket in the Amazon S3 User Guide.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.If you include the
Filter
element in a replication configuration, you must also include theDeleteMarkerReplication
,Status
, andPriority
elements. The response also returns those elements.For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
The following operations are related to
GetBucketReplication
:- Parameters:
getBucketReplicationRequest
-- Returns:
- Result of the GetBucketReplication operation returned by the service.
- See Also:
-
getBucketReplication
default GetBucketReplicationResponse getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.
Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.This action requires permissions for the
s3-outposts:GetReplicationConfiguration
action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket in the Amazon S3 User Guide.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.If you include the
Filter
element in a replication configuration, you must also include theDeleteMarkerReplication
,Status
, andPriority
elements. The response also returns those elements.For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
The following operations are related to
GetBucketReplication
:
This is a convenience which creates an instance of the
GetBucketReplicationRequest.Builder
avoiding the need to create one manually viaGetBucketReplicationRequest.builder()
- Parameters:
getBucketReplicationRequest
- AConsumer
that will call methods onGetBucketReplicationRequest.Builder
to create a request.- Returns:
- Result of the GetBucketReplication operation returned by the service.
- See Also:
-
getBucketTagging
default GetBucketTaggingResponse getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
GetBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.GetBucketTagging
has the following special error:-
Error code:
NoSuchTagSetError
-
Description: There is no tag set associated with the bucket.
-
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
GetBucketTagging
:- Parameters:
getBucketTaggingRequest
-- Returns:
- Result of the GetBucketTagging operation returned by the service.
- See Also:
-
-
getBucketTagging
default GetBucketTaggingResponse getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
GetBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.GetBucketTagging
has the following special error:-
Error code:
NoSuchTagSetError
-
Description: There is no tag set associated with the bucket.
-
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaGetBucketTaggingRequest.builder()
- Parameters:
getBucketTaggingRequest
- AConsumer
that will call methods onGetBucketTaggingRequest.Builder
to create a request.- Returns:
- Result of the GetBucketTagging operation returned by the service.
- See Also:
-
-
getBucketVersioning
default GetBucketVersioningResponse getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.
Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
If you've never set versioning on your bucket, it has no versioning state. In that case, the
GetBucketVersioning
request does not return a versioning state value.For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
GetBucketVersioning
for S3 on Outposts.- Parameters:
getBucketVersioningRequest
-- Returns:
- Result of the GetBucketVersioning operation returned by the service.
- See Also:
-
getBucketVersioning
default GetBucketVersioningResponse getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.
Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
If you've never set versioning on your bucket, it has no versioning state. In that case, the
GetBucketVersioning
request does not return a versioning state value.For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
GetBucketVersioning
for S3 on Outposts.
This is a convenience which creates an instance of the
GetBucketVersioningRequest.Builder
avoiding the need to create one manually viaGetBucketVersioningRequest.builder()
- Parameters:
getBucketVersioningRequest
- AConsumer
that will call methods onGetBucketVersioningRequest.Builder
to create a request.- Returns:
- Result of the GetBucketVersioning operation returned by the service.
- See Also:
-
getDataAccess
default GetDataAccessResponse getDataAccess(GetDataAccessRequest getDataAccessRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.
- Permissions
-
You must have the
s3:GetDataAccess
permission to use this operation. - Additional Permissions
-
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location:
sts:AssumeRole
, for directory users or groupssts:SetContext
, and for IAM users or rolessts:SetSourceIdentity
.
- Parameters:
getDataAccessRequest
-- Returns:
- Result of the GetDataAccess operation returned by the service.
- See Also:
-
getDataAccess
default GetDataAccessResponse getDataAccess(Consumer<GetDataAccessRequest.Builder> getDataAccessRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.
- Permissions
-
You must have the
s3:GetDataAccess
permission to use this operation. - Additional Permissions
-
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location:
sts:AssumeRole
, for directory users or groupssts:SetContext
, and for IAM users or rolessts:SetSourceIdentity
.
This is a convenience which creates an instance of the
GetDataAccessRequest.Builder
avoiding the need to create one manually viaGetDataAccessRequest.builder()
- Parameters:
getDataAccessRequest
- AConsumer
that will call methods onGetDataAccessRequest.Builder
to create a request.- Returns:
- Result of the GetDataAccess operation returned by the service.
- See Also:
-
getJobTagging
default GetJobTaggingResponse getJobTagging(GetJobTaggingRequest getJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException Returns the tags on an S3 Batch Operations job.
- Permissions
-
To use the
GetJobTagging
operation, you must have permission to perform thes3:GetJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
- Parameters:
getJobTaggingRequest
-- Returns:
- Result of the GetJobTagging operation returned by the service.
- See Also:
-
getJobTagging
default GetJobTaggingResponse getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, AwsServiceException, SdkClientException, S3ControlException Returns the tags on an S3 Batch Operations job.
- Permissions
-
To use the
GetJobTagging
operation, you must have permission to perform thes3:GetJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
This is a convenience which creates an instance of the
GetJobTaggingRequest.Builder
avoiding the need to create one manually viaGetJobTaggingRequest.builder()
- Parameters:
getJobTaggingRequest
- AConsumer
that will call methods onGetJobTaggingRequest.Builder
to create a request.- Returns:
- Result of the GetJobTagging operation returned by the service.
- See Also:
-
getMultiRegionAccessPoint
default GetMultiRegionAccessPointResponse getMultiRegionAccessPoint(GetMultiRegionAccessPointRequest getMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration information about the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPoint
:- Parameters:
getMultiRegionAccessPointRequest
-- Returns:
- Result of the GetMultiRegionAccessPoint operation returned by the service.
- See Also:
-
getMultiRegionAccessPoint
default GetMultiRegionAccessPointResponse getMultiRegionAccessPoint(Consumer<GetMultiRegionAccessPointRequest.Builder> getMultiRegionAccessPointRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns configuration information about the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPoint
:
This is a convenience which creates an instance of the
GetMultiRegionAccessPointRequest.Builder
avoiding the need to create one manually viaGetMultiRegionAccessPointRequest.builder()
- Parameters:
getMultiRegionAccessPointRequest
- AConsumer
that will call methods onGetMultiRegionAccessPointRequest.Builder
to create a request.- Returns:
- Result of the GetMultiRegionAccessPoint operation returned by the service.
- See Also:
-
getMultiRegionAccessPointPolicy
default GetMultiRegionAccessPointPolicyResponse getMultiRegionAccessPointPolicy(GetMultiRegionAccessPointPolicyRequest getMultiRegionAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the access control policy of the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicy
:- Parameters:
getMultiRegionAccessPointPolicyRequest
-- Returns:
- Result of the GetMultiRegionAccessPointPolicy operation returned by the service.
- See Also:
-
getMultiRegionAccessPointPolicy
default GetMultiRegionAccessPointPolicyResponse getMultiRegionAccessPointPolicy(Consumer<GetMultiRegionAccessPointPolicyRequest.Builder> getMultiRegionAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the access control policy of the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicy
:
This is a convenience which creates an instance of the
GetMultiRegionAccessPointPolicyRequest.Builder
avoiding the need to create one manually viaGetMultiRegionAccessPointPolicyRequest.builder()
- Parameters:
getMultiRegionAccessPointPolicyRequest
- AConsumer
that will call methods onGetMultiRegionAccessPointPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetMultiRegionAccessPointPolicy operation returned by the service.
- See Also:
-
getMultiRegionAccessPointPolicyStatus
default GetMultiRegionAccessPointPolicyStatusResponse getMultiRegionAccessPointPolicyStatus(GetMultiRegionAccessPointPolicyStatusRequest getMultiRegionAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicyStatus
:- Parameters:
getMultiRegionAccessPointPolicyStatusRequest
-- Returns:
- Result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.
- See Also:
-
getMultiRegionAccessPointPolicyStatus
default GetMultiRegionAccessPointPolicyStatusResponse getMultiRegionAccessPointPolicyStatus(Consumer<GetMultiRegionAccessPointPolicyStatusRequest.Builder> getMultiRegionAccessPointPolicyStatusRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicyStatus
:
This is a convenience which creates an instance of the
GetMultiRegionAccessPointPolicyStatusRequest.Builder
avoiding the need to create one manually viaGetMultiRegionAccessPointPolicyStatusRequest.builder()
- Parameters:
getMultiRegionAccessPointPolicyStatusRequest
- AConsumer
that will call methods onGetMultiRegionAccessPointPolicyStatusRequest.Builder
to create a request.- Returns:
- Result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.
- See Also:
-
getMultiRegionAccessPointRoutes
default GetMultiRegionAccessPointRoutesResponse getMultiRegionAccessPointRoutes(GetMultiRegionAccessPointRoutesRequest getMultiRegionAccessPointRoutesRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
-
us-east-1
-
us-west-2
-
ap-southeast-2
-
ap-northeast-1
-
eu-west-1
- Parameters:
getMultiRegionAccessPointRoutesRequest
-- Returns:
- Result of the GetMultiRegionAccessPointRoutes operation returned by the service.
- See Also:
-
-
getMultiRegionAccessPointRoutes
default GetMultiRegionAccessPointRoutesResponse getMultiRegionAccessPointRoutes(Consumer<GetMultiRegionAccessPointRoutesRequest.Builder> getMultiRegionAccessPointRoutesRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
-
us-east-1
-
us-west-2
-
ap-southeast-2
-
ap-northeast-1
-
eu-west-1
This is a convenience which creates an instance of the
GetMultiRegionAccessPointRoutesRequest.Builder
avoiding the need to create one manually viaGetMultiRegionAccessPointRoutesRequest.builder()
- Parameters:
getMultiRegionAccessPointRoutesRequest
- AConsumer
that will call methods onGetMultiRegionAccessPointRoutesRequest.Builder
to create a request.- Returns:
- Result of the GetMultiRegionAccessPointRoutes operation returned by the service.
- See Also:
-
-
getPublicAccessBlock
default GetPublicAccessBlockResponse getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest) throws NoSuchPublicAccessBlockConfigurationException, AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Retrieves the
PublicAccessBlock
configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.Related actions include:
- Parameters:
getPublicAccessBlockRequest
-- Returns:
- Result of the GetPublicAccessBlock operation returned by the service.
- See Also:
-
getPublicAccessBlock
default GetPublicAccessBlockResponse getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest) throws NoSuchPublicAccessBlockConfigurationException, AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Retrieves the
PublicAccessBlock
configuration for an Amazon Web Services 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 viaGetPublicAccessBlockRequest.builder()
- Parameters:
getPublicAccessBlockRequest
- AConsumer
that will call methods onGetPublicAccessBlockRequest.Builder
to create a request.- Returns:
- Result of the GetPublicAccessBlock operation returned by the service.
- See Also:
-
getStorageLensConfiguration
default GetStorageLensConfigurationResponse getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:GetStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
getStorageLensConfigurationRequest
-- Returns:
- Result of the GetStorageLensConfiguration operation returned by the service.
- See Also:
-
getStorageLensConfiguration
default GetStorageLensConfigurationResponse getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:GetStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
GetStorageLensConfigurationRequest.Builder
avoiding the need to create one manually viaGetStorageLensConfigurationRequest.builder()
- Parameters:
getStorageLensConfigurationRequest
- AConsumer
that will call methods onGetStorageLensConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetStorageLensConfiguration operation returned by the service.
- See Also:
-
getStorageLensConfigurationTagging
default GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
getStorageLensConfigurationTaggingRequest
-- Returns:
- Result of the GetStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
getStorageLensConfigurationTagging
default GetStorageLensConfigurationTaggingResponse getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
GetStorageLensConfigurationTaggingRequest.Builder
avoiding the need to create one manually viaGetStorageLensConfigurationTaggingRequest.builder()
- Parameters:
getStorageLensConfigurationTaggingRequest
- AConsumer
that will call methods onGetStorageLensConfigurationTaggingRequest.Builder
to create a request.- Returns:
- Result of the GetStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
getStorageLensGroup
default GetStorageLensGroupResponse getStorageLensGroup(GetStorageLensGroupRequest getStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the Storage Lens group configuration details.
To use this operation, you must have the permission to perform the
s3:GetStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
- Parameters:
getStorageLensGroupRequest
-- Returns:
- Result of the GetStorageLensGroup operation returned by the service.
- See Also:
-
getStorageLensGroup
default GetStorageLensGroupResponse getStorageLensGroup(Consumer<GetStorageLensGroupRequest.Builder> getStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Retrieves the Storage Lens group configuration details.
To use this operation, you must have the permission to perform the
s3:GetStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
This is a convenience which creates an instance of the
GetStorageLensGroupRequest.Builder
avoiding the need to create one manually viaGetStorageLensGroupRequest.builder()
- Parameters:
getStorageLensGroupRequest
- AConsumer
that will call methods onGetStorageLensGroupRequest.Builder
to create a request.- Returns:
- Result of the GetStorageLensGroup operation returned by the service.
- See Also:
-
listAccessGrants
default ListAccessGrantsResponse listAccessGrants(ListAccessGrantsRequest listAccessGrantsRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns the list of access grants in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:ListAccessGrants
permission to use this operation.
- Parameters:
listAccessGrantsRequest
-- Returns:
- Result of the ListAccessGrants operation returned by the service.
- See Also:
-
listAccessGrants
default ListAccessGrantsResponse listAccessGrants(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns the list of access grants in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:ListAccessGrants
permission to use this operation.
This is a convenience which creates an instance of the
ListAccessGrantsRequest.Builder
avoiding the need to create one manually viaListAccessGrantsRequest.builder()
- Parameters:
listAccessGrantsRequest
- AConsumer
that will call methods onListAccessGrantsRequest.Builder
to create a request.- Returns:
- Result of the ListAccessGrants operation returned by the service.
- See Also:
-
listAccessGrantsPaginator
default ListAccessGrantsIterable listAccessGrantsPaginator(ListAccessGrantsRequest listAccessGrantsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client.listAccessGrantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client .listAccessGrantsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client.listAccessGrantsPaginator(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
listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
operation.- Parameters:
listAccessGrantsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessGrantsPaginator
default ListAccessGrantsIterable listAccessGrantsPaginator(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client.listAccessGrantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client .listAccessGrantsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsIterable responses = client.listAccessGrantsPaginator(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
listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest)
operation.
This is a convenience which creates an instance of the
ListAccessGrantsRequest.Builder
avoiding the need to create one manually viaListAccessGrantsRequest.builder()
- Parameters:
listAccessGrantsRequest
- AConsumer
that will call methods onListAccessGrantsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessGrantsInstances
default ListAccessGrantsInstancesResponse listAccessGrantsInstances(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.
- Permissions
-
You must have the
s3:ListAccessGrantsInstances
permission to use this operation.
- Parameters:
listAccessGrantsInstancesRequest
-- Returns:
- Result of the ListAccessGrantsInstances operation returned by the service.
- See Also:
-
listAccessGrantsInstances
default ListAccessGrantsInstancesResponse listAccessGrantsInstances(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.
- Permissions
-
You must have the
s3:ListAccessGrantsInstances
permission to use this operation.
This is a convenience which creates an instance of the
ListAccessGrantsInstancesRequest.Builder
avoiding the need to create one manually viaListAccessGrantsInstancesRequest.builder()
- Parameters:
listAccessGrantsInstancesRequest
- AConsumer
that will call methods onListAccessGrantsInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListAccessGrantsInstances operation returned by the service.
- See Also:
-
listAccessGrantsInstancesPaginator
default ListAccessGrantsInstancesIterable listAccessGrantsInstancesPaginator(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client.listAccessGrantsInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client .listAccessGrantsInstancesPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client.listAccessGrantsInstancesPaginator(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
listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
operation.- Parameters:
listAccessGrantsInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessGrantsInstancesPaginator
default ListAccessGrantsInstancesIterable listAccessGrantsInstancesPaginator(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client.listAccessGrantsInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client .listAccessGrantsInstancesPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesIterable responses = client.listAccessGrantsInstancesPaginator(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
listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListAccessGrantsInstancesRequest.Builder
avoiding the need to create one manually viaListAccessGrantsInstancesRequest.builder()
- Parameters:
listAccessGrantsInstancesRequest
- AConsumer
that will call methods onListAccessGrantsInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessGrantsLocations
default ListAccessGrantsLocationsResponse listAccessGrantsLocations(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a list of the locations registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:ListAccessGrantsLocations
permission to use this operation.
- Parameters:
listAccessGrantsLocationsRequest
-- Returns:
- Result of the ListAccessGrantsLocations operation returned by the service.
- See Also:
-
listAccessGrantsLocations
default ListAccessGrantsLocationsResponse listAccessGrantsLocations(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest) throws AwsServiceException, SdkClientException, S3ControlException Returns a list of the locations registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:ListAccessGrantsLocations
permission to use this operation.
This is a convenience which creates an instance of the
ListAccessGrantsLocationsRequest.Builder
avoiding the need to create one manually viaListAccessGrantsLocationsRequest.builder()
- Parameters:
listAccessGrantsLocationsRequest
- AConsumer
that will call methods onListAccessGrantsLocationsRequest.Builder
to create a request.- Returns:
- Result of the ListAccessGrantsLocations operation returned by the service.
- See Also:
-
listAccessGrantsLocationsPaginator
default ListAccessGrantsLocationsIterable listAccessGrantsLocationsPaginator(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client.listAccessGrantsLocationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client .listAccessGrantsLocationsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client.listAccessGrantsLocationsPaginator(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
listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
operation.- Parameters:
listAccessGrantsLocationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessGrantsLocationsPaginator
default ListAccessGrantsLocationsIterable listAccessGrantsLocationsPaginator(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client.listAccessGrantsLocationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client .listAccessGrantsLocationsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsIterable responses = client.listAccessGrantsLocationsPaginator(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
listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest)
operation.
This is a convenience which creates an instance of the
ListAccessGrantsLocationsRequest.Builder
avoiding the need to create one manually viaListAccessGrantsLocationsRequest.builder()
- Parameters:
listAccessGrantsLocationsRequest
- AConsumer
that will call methods onListAccessGrantsLocationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessPoints
default ListAccessPointsResponse listAccessPoints(ListAccessPointsRequest listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in
maxResults
, whichever is less), the response will include a continuation token that you can use to list the additional access points.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
ListAccessPoints
:- Parameters:
listAccessPointsRequest
-- Returns:
- Result of the ListAccessPoints operation returned by the service.
- See Also:
-
listAccessPoints
default ListAccessPointsResponse listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in
maxResults
, whichever is less), the response will include a continuation token that you can use to list the additional access points.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaListAccessPointsRequest.builder()
- Parameters:
listAccessPointsRequest
- AConsumer
that will call methods onListAccessPointsRequest.Builder
to create a request.- Returns:
- Result of the ListAccessPoints operation returned by the service.
- See Also:
-
listAccessPointsPaginator
default ListAccessPointsIterable listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest)
operation.- Parameters:
listAccessPointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessPointsPaginator
default ListAccessPointsIterable listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsIterable responses = client.listAccessPointsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAccessPointsRequest.builder()
- Parameters:
listAccessPointsRequest
- AConsumer
that will call methods onListAccessPointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessPointsForObjectLambda
default ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.
The following actions are related to
ListAccessPointsForObjectLambda
:- Parameters:
listAccessPointsForObjectLambdaRequest
-- Returns:
- Result of the ListAccessPointsForObjectLambda operation returned by the service.
- See Also:
-
listAccessPointsForObjectLambda
default ListAccessPointsForObjectLambdaResponse listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.
The following actions are related to
ListAccessPointsForObjectLambda
:
This is a convenience which creates an instance of the
ListAccessPointsForObjectLambdaRequest.Builder
avoiding the need to create one manually viaListAccessPointsForObjectLambdaRequest.builder()
- Parameters:
listAccessPointsForObjectLambdaRequest
- AConsumer
that will call methods onListAccessPointsForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the ListAccessPointsForObjectLambda operation returned by the service.
- See Also:
-
listAccessPointsForObjectLambdaPaginator
default ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest)
operation.- Parameters:
listAccessPointsForObjectLambdaRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessPointsForObjectLambdaPaginator
default ListAccessPointsForObjectLambdaIterable listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaIterable responses = client.listAccessPointsForObjectLambdaPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAccessPointsForObjectLambdaRequest.builder()
- Parameters:
listAccessPointsForObjectLambdaRequest
- AConsumer
that will call methods onListAccessPointsForObjectLambdaRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobs
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
ListJobs
operation, you must have permission to perform thes3:ListJobs
action.
Related actions include:
- Parameters:
listJobsRequest
-- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
listJobs
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
ListJobs
operation, you must have permission to perform thes3:ListJobs
action.
Related actions include:
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation.- Parameters:
listJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, InternalServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMultiRegionAccessPoints
default ListMultiRegionAccessPointsResponse listMultiRegionAccessPoints(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
ListMultiRegionAccessPoint
:- Parameters:
listMultiRegionAccessPointsRequest
-- Returns:
- Result of the ListMultiRegionAccessPoints operation returned by the service.
- See Also:
-
listMultiRegionAccessPoints
default ListMultiRegionAccessPointsResponse listMultiRegionAccessPoints(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
ListMultiRegionAccessPoint
:
This is a convenience which creates an instance of the
ListMultiRegionAccessPointsRequest.Builder
avoiding the need to create one manually viaListMultiRegionAccessPointsRequest.builder()
- Parameters:
listMultiRegionAccessPointsRequest
- AConsumer
that will call methods onListMultiRegionAccessPointsRequest.Builder
to create a request.- Returns:
- Result of the ListMultiRegionAccessPoints operation returned by the service.
- See Also:
-
listMultiRegionAccessPointsPaginator
default ListMultiRegionAccessPointsIterable listMultiRegionAccessPointsPaginator(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client .listMultiRegionAccessPointsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation.- Parameters:
listMultiRegionAccessPointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMultiRegionAccessPointsPaginator
default ListMultiRegionAccessPointsIterable listMultiRegionAccessPointsPaginator(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client .listMultiRegionAccessPointsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsIterable responses = client.listMultiRegionAccessPointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest)
operation.
This is a convenience which creates an instance of the
ListMultiRegionAccessPointsRequest.Builder
avoiding the need to create one manually viaListMultiRegionAccessPointsRequest.builder()
- Parameters:
listMultiRegionAccessPointsRequest
- AConsumer
that will call methods onListMultiRegionAccessPointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRegionalBuckets
default ListRegionalBucketsResponse listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your request, see the Examples section.- Parameters:
listRegionalBucketsRequest
-- Returns:
- Result of the ListRegionalBuckets operation returned by the service.
- See Also:
-
listRegionalBuckets
default ListRegionalBucketsResponse listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your request, see the Examples section.
This is a convenience which creates an instance of the
ListRegionalBucketsRequest.Builder
avoiding the need to create one manually viaListRegionalBucketsRequest.builder()
- Parameters:
listRegionalBucketsRequest
- AConsumer
that will call methods onListRegionalBucketsRequest.Builder
to create a request.- Returns:
- Result of the ListRegionalBuckets operation returned by the service.
- See Also:
-
listRegionalBucketsPaginator
default ListRegionalBucketsIterable listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest)
operation.- Parameters:
listRegionalBucketsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRegionalBucketsPaginator
default ListRegionalBucketsIterable listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsIterable responses = client.listRegionalBucketsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListRegionalBucketsRequest.builder()
- Parameters:
listRegionalBucketsRequest
- AConsumer
that will call methods onListRegionalBucketsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageLensConfigurations
default ListStorageLensConfigurationsResponse listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:ListStorageLensConfigurations
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
listStorageLensConfigurationsRequest
-- Returns:
- Result of the ListStorageLensConfigurations operation returned by the service.
- See Also:
-
listStorageLensConfigurations
default ListStorageLensConfigurationsResponse listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:ListStorageLensConfigurations
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
ListStorageLensConfigurationsRequest.Builder
avoiding the need to create one manually viaListStorageLensConfigurationsRequest.builder()
- Parameters:
listStorageLensConfigurationsRequest
- AConsumer
that will call methods onListStorageLensConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListStorageLensConfigurations operation returned by the service.
- See Also:
-
listStorageLensConfigurationsPaginator
default ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest)
operation.- Parameters:
listStorageLensConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageLensConfigurationsPaginator
default ListStorageLensConfigurationsIterable listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest) throws AwsServiceException, SdkClientException, S3ControlException 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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsIterable responses = client.listStorageLensConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListStorageLensConfigurationsRequest.builder()
- Parameters:
listStorageLensConfigurationsRequest
- AConsumer
that will call methods onListStorageLensConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageLensGroups
default ListStorageLensGroupsResponse listStorageLensGroups(ListStorageLensGroupsRequest listStorageLensGroupsRequest) throws AwsServiceException, SdkClientException, S3ControlException Lists all the Storage Lens groups in the specified home Region.
To use this operation, you must have the permission to perform the
s3:ListStorageLensGroups
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
- Parameters:
listStorageLensGroupsRequest
-- Returns:
- Result of the ListStorageLensGroups operation returned by the service.
- See Also:
-
listStorageLensGroups
default ListStorageLensGroupsResponse listStorageLensGroups(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest) throws AwsServiceException, SdkClientException, S3ControlException Lists all the Storage Lens groups in the specified home Region.
To use this operation, you must have the permission to perform the
s3:ListStorageLensGroups
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
This is a convenience which creates an instance of the
ListStorageLensGroupsRequest.Builder
avoiding the need to create one manually viaListStorageLensGroupsRequest.builder()
- Parameters:
listStorageLensGroupsRequest
- AConsumer
that will call methods onListStorageLensGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListStorageLensGroups operation returned by the service.
- See Also:
-
listStorageLensGroupsPaginator
default ListStorageLensGroupsIterable listStorageLensGroupsPaginator(ListStorageLensGroupsRequest listStorageLensGroupsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client.listStorageLensGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client .listStorageLensGroupsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client.listStorageLensGroupsPaginator(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
listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
operation.- Parameters:
listStorageLensGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageLensGroupsPaginator
default ListStorageLensGroupsIterable listStorageLensGroupsPaginator(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest) throws AwsServiceException, SdkClientException, S3ControlException This is a variant of
listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
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 Streamsoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client.listStorageLensGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client .listStorageLensGroupsPaginator(request); for (software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsIterable responses = client.listStorageLensGroupsPaginator(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
listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListStorageLensGroupsRequest.Builder
avoiding the need to create one manually viaListStorageLensGroupsRequest.builder()
- Parameters:
listStorageLensGroupsRequest
- AConsumer
that will call methods onListStorageLensGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation allows you to list all the Amazon Web Services resource tags for a specified resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Permissions
-
You must have the
s3:ListTagsForResource
permission to use this operation.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation allows you to list all the Amazon Web Services resource tags for a specified resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Permissions
-
You must have the
s3:ListTagsForResource
permission to use this operation.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putAccessGrantsInstanceResourcePolicy
default PutAccessGrantsInstanceResourcePolicyResponse putAccessGrantsInstanceResourcePolicy(PutAccessGrantsInstanceResourcePolicyRequest putAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the resource policy of the S3 Access Grants instance.
- Permissions
-
You must have the
s3:PutAccessGrantsInstanceResourcePolicy
permission to use this operation.
- Parameters:
putAccessGrantsInstanceResourcePolicyRequest
-- Returns:
- Result of the PutAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
putAccessGrantsInstanceResourcePolicy
default PutAccessGrantsInstanceResourcePolicyResponse putAccessGrantsInstanceResourcePolicy(Consumer<PutAccessGrantsInstanceResourcePolicyRequest.Builder> putAccessGrantsInstanceResourcePolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the resource policy of the S3 Access Grants instance.
- Permissions
-
You must have the
s3:PutAccessGrantsInstanceResourcePolicy
permission to use this operation.
This is a convenience which creates an instance of the
PutAccessGrantsInstanceResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutAccessGrantsInstanceResourcePolicyRequest.builder()
- Parameters:
putAccessGrantsInstanceResourcePolicyRequest
- AConsumer
that will call methods onPutAccessGrantsInstanceResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutAccessGrantsInstanceResourcePolicy operation returned by the service.
- See Also:
-
putAccessPointConfigurationForObjectLambda
default PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Replaces configuration for an Object Lambda Access Point.
The following actions are related to
PutAccessPointConfigurationForObjectLambda
:- Parameters:
putAccessPointConfigurationForObjectLambdaRequest
-- Returns:
- Result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.
- See Also:
-
putAccessPointConfigurationForObjectLambda
default PutAccessPointConfigurationForObjectLambdaResponse putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
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 viaPutAccessPointConfigurationForObjectLambdaRequest.builder()
- Parameters:
putAccessPointConfigurationForObjectLambdaRequest
- AConsumer
that will call methods onPutAccessPointConfigurationForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.
- See Also:
-
putAccessPointPolicy
default PutAccessPointPolicyResponse putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
PutAccessPointPolicy
:- Parameters:
putAccessPointPolicyRequest
-- Returns:
- Result of the PutAccessPointPolicy operation returned by the service.
- See Also:
-
putAccessPointPolicy
default PutAccessPointPolicyResponse putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaPutAccessPointPolicyRequest.builder()
- Parameters:
putAccessPointPolicyRequest
- AConsumer
that will call methods onPutAccessPointPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutAccessPointPolicy operation returned by the service.
- See Also:
-
putAccessPointPolicyForObjectLambda
default PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
PutAccessPointPolicyForObjectLambda
:- Parameters:
putAccessPointPolicyForObjectLambdaRequest
-- Returns:
- Result of the PutAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
putAccessPointPolicyForObjectLambda
default PutAccessPointPolicyForObjectLambdaResponse putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
PutAccessPointPolicyForObjectLambda
:
This is a convenience which creates an instance of the
PutAccessPointPolicyForObjectLambdaRequest.Builder
avoiding the need to create one manually viaPutAccessPointPolicyForObjectLambdaRequest.builder()
- Parameters:
putAccessPointPolicyForObjectLambdaRequest
- AConsumer
that will call methods onPutAccessPointPolicyForObjectLambdaRequest.Builder
to create a request.- Returns:
- Result of the PutAccessPointPolicyForObjectLambda operation returned by the service.
- See Also:
-
putBucketLifecycleConfiguration
default PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
PutBucketLifecycleConfiguration
:- Parameters:
putBucketLifecycleConfigurationRequest
-- Returns:
- Result of the PutBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
putBucketLifecycleConfiguration
default PutBucketLifecycleConfigurationResponse putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaPutBucketLifecycleConfigurationRequest.builder()
- Parameters:
putBucketLifecycleConfigurationRequest
- AConsumer
that will call methods onPutBucketLifecycleConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutBucketLifecycleConfiguration operation returned by the service.
- See Also:
-
putBucketPolicy
default PutBucketPolicyResponse putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the
PutBucketPolicy
permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.If you don't have
PutBucketPolicy
permissions, Amazon S3 returns a403 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 a405 Method Not Allowed
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
PutBucketPolicy
:- Parameters:
putBucketPolicyRequest
-- Returns:
- Result of the PutBucketPolicy operation returned by the service.
- See Also:
-
putBucketPolicy
default PutBucketPolicyResponse putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the
PutBucketPolicy
permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.If you don't have
PutBucketPolicy
permissions, Amazon S3 returns a403 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 a405 Method Not Allowed
error.As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaPutBucketPolicyRequest.builder()
- Parameters:
putBucketPolicyRequest
- AConsumer
that will call methods onPutBucketPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutBucketPolicy operation returned by the service.
- See Also:
-
putBucketReplication
default PutBucketReplicationResponse putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API Reference.
Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.Specify the replication configuration in the request body. In the replication configuration, you provide the following information:
-
The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects
-
The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf
-
Other relevant information, such as replication rules
A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source Outposts bucket to apply a replication rule to, add the
Filter
element as a child of theRule
element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add theFilter
element in the configuration, you must also add the following elements:DeleteMarkerReplication
,Status
, andPriority
.Using
PutBucketReplication
on Outposts requires that both the source and destination buckets must have versioning enabled. For information about enabling versioning on a bucket, see Managing S3 Versioning for your S3 on Outposts bucket.For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
Handling Replication of Encrypted Objects
Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.
Permissions
To create a
PutBucketReplication
request, you must haves3-outposts:PutReplicationConfiguration
permissions for the bucket. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets.To perform this operation, the user or role must also have the
iam:CreateRole
andiam:PassRole
permissions. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
PutBucketReplication
:- Parameters:
putBucketReplicationRequest
-- Returns:
- Result of the PutBucketReplication operation returned by the service.
- See Also:
-
-
putBucketReplication
default PutBucketReplicationResponse putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest) throws AwsServiceException, SdkClientException, S3ControlException This action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API Reference.
Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
It can take a while to propagate
PUT
orDELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the replication configuration that's returned by aGET
request soon after aPUT
orDELETE
request might return a more recent result than what's on the Outpost. If an Outpost is offline, the delay in updating the replication configuration on that Outpost can be significant.Specify the replication configuration in the request body. In the replication configuration, you provide the following information:
-
The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects
-
The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf
-
Other relevant information, such as replication rules
A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source Outposts bucket to apply a replication rule to, add the
Filter
element as a child of theRule
element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add theFilter
element in the configuration, you must also add the following elements:DeleteMarkerReplication
,Status
, andPriority
.Using
PutBucketReplication
on Outposts requires that both the source and destination buckets must have versioning enabled. For information about enabling versioning on a bucket, see Managing S3 Versioning for your S3 on Outposts bucket.For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
Handling Replication of Encrypted Objects
Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.
Permissions
To create a
PutBucketReplication
request, you must haves3-outposts:PutReplicationConfiguration
permissions for the bucket. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets.To perform this operation, the user or role must also have the
iam:CreateRole
andiam:PassRole
permissions. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
PutBucketReplication
:
This is a convenience which creates an instance of the
PutBucketReplicationRequest.Builder
avoiding the need to create one manually viaPutBucketReplicationRequest.builder()
- Parameters:
putBucketReplicationRequest
- AConsumer
that will call methods onPutBucketReplicationRequest.Builder
to create a request.- Returns:
- Result of the PutBucketReplication operation returned by the service.
- See Also:
-
-
putBucketTagging
default PutBucketTaggingResponse putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.
To use this action, you must have permissions to perform the
s3-outposts:PutBucketTagging
action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.PutBucketTagging
has the following special errors:-
Error code:
InvalidTagError
-
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
-
-
Error code:
MalformedXMLError
-
Description: The XML provided does not match the schema.
-
-
Error code:
OperationAbortedError
-
Description: A conflicting conditional action is currently in progress against this resource. Try again.
-
-
Error code:
InternalError
-
Description: The service was unable to apply the provided tag to the bucket.
-
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following actions are related to
PutBucketTagging
:- Parameters:
putBucketTaggingRequest
-- Returns:
- Result of the PutBucketTagging operation returned by the service.
- See Also:
-
-
putBucketTagging
default PutBucketTaggingResponse putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.
To use this action, you must have permissions to perform the
s3-outposts:PutBucketTagging
action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.PutBucketTagging
has the following special errors:-
Error code:
InvalidTagError
-
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
-
-
Error code:
MalformedXMLError
-
Description: The XML provided does not match the schema.
-
-
Error code:
OperationAbortedError
-
Description: A conflicting conditional action is currently in progress against this resource. Try again.
-
-
Error code:
InternalError
-
Description: The service was unable to apply the provided tag to the bucket.
-
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by 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 viaPutBucketTaggingRequest.builder()
- Parameters:
putBucketTaggingRequest
- AConsumer
that will call methods onPutBucketTaggingRequest.Builder
to create a request.- Returns:
- Result of the PutBucketTagging operation returned by the service.
- See Also:
-
-
putBucketVersioning
default PutBucketVersioningResponse putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.
Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
You can set the versioning state to one of the following:
-
Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
-
Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID
null
.
If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.
When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.
If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
PutBucketVersioning
for S3 on Outposts.- Parameters:
putBucketVersioningRequest
-- Returns:
- Result of the PutBucketVersioning operation returned by the service.
- See Also:
-
-
putBucketVersioning
default PutBucketVersioningResponse putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.
Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
You can set the versioning state to one of the following:
-
Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
-
Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID
null
.
If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.
When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.
If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id
to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead ofs3-control
. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and thex-amz-outpost-id
derived by using the access point ARN, see the Examples section.The following operations are related to
PutBucketVersioning
for S3 on Outposts.
This is a convenience which creates an instance of the
PutBucketVersioningRequest.Builder
avoiding the need to create one manually viaPutBucketVersioningRequest.builder()
- Parameters:
putBucketVersioningRequest
- AConsumer
that will call methods onPutBucketVersioningRequest.Builder
to create a request.- Returns:
- Result of the PutBucketVersioning operation returned by the service.
- See Also:
-
-
putJobTagging
default PutJobTaggingResponse putJobTagging(PutJobTaggingRequest putJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, S3ControlException Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
-
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
-
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
-
A few things to consider about using tags:
-
Amazon S3 limits the maximum number of tags to 50 tags per job.
-
You can associate up to 50 tags with a job as long as they have unique tag keys.
-
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
-
The key and values are case sensitive.
-
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
-
- Permissions
-
To use the
PutJobTagging
operation, you must have permission to perform thes3:PutJobTagging
action.
Related actions include:
- Parameters:
putJobTaggingRequest
-- Returns:
- Result of the PutJobTagging operation returned by the service.
- See Also:
-
-
putJobTagging
default PutJobTaggingResponse putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest) throws InternalServiceException, TooManyRequestsException, NotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, S3ControlException Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
-
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
-
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
-
A few things to consider about using tags:
-
Amazon S3 limits the maximum number of tags to 50 tags per job.
-
You can associate up to 50 tags with a job as long as they have unique tag keys.
-
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
-
The key and values are case sensitive.
-
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
-
- Permissions
-
To use the
PutJobTagging
operation, you must have permission to perform thes3:PutJobTagging
action.
Related actions include:
This is a convenience which creates an instance of the
PutJobTaggingRequest.Builder
avoiding the need to create one manually viaPutJobTaggingRequest.builder()
- Parameters:
putJobTaggingRequest
- AConsumer
that will call methods onPutJobTaggingRequest.Builder
to create a request.- Returns:
- Result of the PutJobTagging operation returned by the service.
- See Also:
-
-
putMultiRegionAccessPointPolicy
default PutMultiRegionAccessPointPolicyResponse putMultiRegionAccessPointPolicy(PutMultiRegionAccessPointPolicyRequest putMultiRegionAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
PutMultiRegionAccessPointPolicy
:- Parameters:
putMultiRegionAccessPointPolicyRequest
-- Returns:
- Result of the PutMultiRegionAccessPointPolicy operation returned by the service.
- See Also:
-
putMultiRegionAccessPointPolicy
default PutMultiRegionAccessPointPolicyResponse putMultiRegionAccessPointPolicy(Consumer<PutMultiRegionAccessPointPolicyRequest.Builder> putMultiRegionAccessPointPolicyRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
PutMultiRegionAccessPointPolicy
:
This is a convenience which creates an instance of the
PutMultiRegionAccessPointPolicyRequest.Builder
avoiding the need to create one manually viaPutMultiRegionAccessPointPolicyRequest.builder()
- Parameters:
putMultiRegionAccessPointPolicyRequest
- AConsumer
that will call methods onPutMultiRegionAccessPointPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutMultiRegionAccessPointPolicy operation returned by the service.
- See Also:
-
putPublicAccessBlock
default PutPublicAccessBlockResponse putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates or modifies the
PublicAccessBlock
configuration for an Amazon Web Services account. For this operation, users must have thes3:PutAccountPublicAccessBlock
permission. For more information, see Using Amazon S3 block public access.Related actions include:
- Parameters:
putPublicAccessBlockRequest
-- Returns:
- Result of the PutPublicAccessBlock operation returned by the service.
- See Also:
-
putPublicAccessBlock
default PutPublicAccessBlockResponse putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Creates or modifies the
PublicAccessBlock
configuration for an Amazon Web Services account. For this operation, users must have thes3:PutAccountPublicAccessBlock
permission. 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 viaPutPublicAccessBlockRequest.builder()
- Parameters:
putPublicAccessBlockRequest
- AConsumer
that will call methods onPutPublicAccessBlockRequest.Builder
to create a request.- Returns:
- Result of the PutPublicAccessBlock operation returned by the service.
- See Also:
-
putStorageLensConfiguration
default PutStorageLensConfigurationResponse putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:PutStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
putStorageLensConfigurationRequest
-- Returns:
- Result of the PutStorageLensConfiguration operation returned by the service.
- See Also:
-
putStorageLensConfiguration
default PutStorageLensConfigurationResponse putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:PutStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
PutStorageLensConfigurationRequest.Builder
avoiding the need to create one manually viaPutStorageLensConfigurationRequest.builder()
- Parameters:
putStorageLensConfigurationRequest
- AConsumer
that will call methods onPutStorageLensConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutStorageLensConfiguration operation returned by the service.
- See Also:
-
putStorageLensConfigurationTagging
default PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:PutStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.- Parameters:
putStorageLensConfigurationTaggingRequest
-- Returns:
- Result of the PutStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
putStorageLensConfigurationTagging
default PutStorageLensConfigurationTaggingResponse putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3:PutStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
This is a convenience which creates an instance of the
PutStorageLensConfigurationTaggingRequest.Builder
avoiding the need to create one manually viaPutStorageLensConfigurationTaggingRequest.builder()
- Parameters:
putStorageLensConfigurationTaggingRequest
- AConsumer
that will call methods onPutStorageLensConfigurationTaggingRequest.Builder
to create a request.- Returns:
- Result of the PutStorageLensConfigurationTagging operation returned by the service.
- See Also:
-
submitMultiRegionAccessPointRoutes
default SubmitMultiRegionAccessPointRoutesResponse submitMultiRegionAccessPointRoutes(SubmitMultiRegionAccessPointRoutesRequest submitMultiRegionAccessPointRoutesRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of
0
indicates a passive status, which means that traffic won't be routed to the specified Region. A value of100
indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.
Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.
To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
-
us-east-1
-
us-west-2
-
ap-southeast-2
-
ap-northeast-1
-
eu-west-1
- Parameters:
submitMultiRegionAccessPointRoutesRequest
-- Returns:
- Result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.
- See Also:
-
-
submitMultiRegionAccessPointRoutes
default SubmitMultiRegionAccessPointRoutesResponse submitMultiRegionAccessPointRoutes(Consumer<SubmitMultiRegionAccessPointRoutesRequest.Builder> submitMultiRegionAccessPointRoutesRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation is not supported by directory buckets.
Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of
0
indicates a passive status, which means that traffic won't be routed to the specified Region. A value of100
indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.
Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect.
To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
-
us-east-1
-
us-west-2
-
ap-southeast-2
-
ap-northeast-1
-
eu-west-1
This is a convenience which creates an instance of the
SubmitMultiRegionAccessPointRoutesRequest.Builder
avoiding the need to create one manually viaSubmitMultiRegionAccessPointRoutesRequest.builder()
- Parameters:
submitMultiRegionAccessPointRoutesRequest
- AConsumer
that will call methods onSubmitMultiRegionAccessPointRoutesRequest.Builder
to create a request.- Returns:
- Result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates a new Amazon Web Services resource tag or updates an existing resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
- Permissions
-
You must have the
s3:TagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException Creates a new Amazon Web Services resource tag or updates an existing resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
- Permissions
-
You must have the
s3:TagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation removes the specified Amazon Web Services resource tags from an S3 resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
- Permissions
-
You must have the
s3:UntagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AwsServiceException, SdkClientException, S3ControlException This operation removes the specified Amazon Web Services resource tags from an S3 resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
- Permissions
-
You must have the
s3:UntagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAccessGrantsLocation
default UpdateAccessGrantsLocationResponse updateAccessGrantsLocation(UpdateAccessGrantsLocationRequest updateAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the IAM role of a registered location in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:UpdateAccessGrantsLocation
permission to use this operation. - Additional Permissions
-
You must also have the following permission:
iam:PassRole
- Parameters:
updateAccessGrantsLocationRequest
-- Returns:
- Result of the UpdateAccessGrantsLocation operation returned by the service.
- See Also:
-
updateAccessGrantsLocation
default UpdateAccessGrantsLocationResponse updateAccessGrantsLocation(Consumer<UpdateAccessGrantsLocationRequest.Builder> updateAccessGrantsLocationRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the IAM role of a registered location in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:UpdateAccessGrantsLocation
permission to use this operation. - Additional Permissions
-
You must also have the following permission:
iam:PassRole
This is a convenience which creates an instance of the
UpdateAccessGrantsLocationRequest.Builder
avoiding the need to create one manually viaUpdateAccessGrantsLocationRequest.builder()
- Parameters:
updateAccessGrantsLocationRequest
- AConsumer
that will call methods onUpdateAccessGrantsLocationRequest.Builder
to create a request.- Returns:
- Result of the UpdateAccessGrantsLocation operation returned by the service.
- See Also:
-
updateJobPriority
default UpdateJobPriorityResponse updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobPriority
operation, you must have permission to perform thes3:UpdateJobPriority
action.
Related actions include:
- Parameters:
updateJobPriorityRequest
-- Returns:
- Result of the UpdateJobPriority operation returned by the service.
- See Also:
-
updateJobPriority
default UpdateJobPriorityResponse updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobPriority
operation, you must have permission to perform thes3:UpdateJobPriority
action.
Related actions include:
This is a convenience which creates an instance of the
UpdateJobPriorityRequest.Builder
avoiding the need to create one manually viaUpdateJobPriorityRequest.builder()
- Parameters:
updateJobPriorityRequest
- AConsumer
that will call methods onUpdateJobPriorityRequest.Builder
to create a request.- Returns:
- Result of the UpdateJobPriority operation returned by the service.
- See Also:
-
updateJobStatus
default UpdateJobStatusResponse updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, JobStatusException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobStatus
operation, you must have permission to perform thes3:UpdateJobStatus
action.
Related actions include:
- Parameters:
updateJobStatusRequest
-- Returns:
- Result of the UpdateJobStatus operation returned by the service.
- See Also:
-
updateJobStatus
default UpdateJobStatusResponse updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest) throws BadRequestException, TooManyRequestsException, NotFoundException, JobStatusException, InternalServiceException, AwsServiceException, SdkClientException, S3ControlException Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobStatus
operation, you must have permission to perform thes3:UpdateJobStatus
action.
Related actions include:
This is a convenience which creates an instance of the
UpdateJobStatusRequest.Builder
avoiding the need to create one manually viaUpdateJobStatusRequest.builder()
- Parameters:
updateJobStatusRequest
- AConsumer
that will call methods onUpdateJobStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdateJobStatus operation returned by the service.
- See Also:
-
updateStorageLensGroup
default UpdateStorageLensGroupResponse updateStorageLensGroup(UpdateStorageLensGroupRequest updateStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the existing Storage Lens group.
To use this operation, you must have the permission to perform the
s3:UpdateStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
- Parameters:
updateStorageLensGroupRequest
-- Returns:
- Result of the UpdateStorageLensGroup operation returned by the service.
- See Also:
-
updateStorageLensGroup
default UpdateStorageLensGroupResponse updateStorageLensGroup(Consumer<UpdateStorageLensGroupRequest.Builder> updateStorageLensGroupRequest) throws AwsServiceException, SdkClientException, S3ControlException Updates the existing Storage Lens group.
To use this operation, you must have the permission to perform the
s3:UpdateStorageLensGroup
action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
This is a convenience which creates an instance of the
UpdateStorageLensGroupRequest.Builder
avoiding the need to create one manually viaUpdateStorageLensGroupRequest.builder()
- Parameters:
updateStorageLensGroupRequest
- AConsumer
that will call methods onUpdateStorageLensGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateStorageLensGroup operation returned by the service.
- See Also:
-
create
Create aS3ControlClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aS3ControlClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-