Package software.amazon.awssdk.services.s3control

Interface S3ControlAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface S3ControlAsyncClient extends AwsClient
Service client for accessing AWS S3 Control asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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

  • Field Details

  • Method Details

    • associateAccessGrantsIdentityCenter

      default CompletableFuture<AssociateAccessGrantsIdentityCenterResponse> associateAccessGrantsIdentityCenter(AssociateAccessGrantsIdentityCenterRequest associateAccessGrantsIdentityCenterRequest)

      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, and sso:PutApplicationAuthenticationMethod.

      Parameters:
      associateAccessGrantsIdentityCenterRequest -
      Returns:
      A Java Future containing the result of the AssociateAccessGrantsIdentityCenter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateAccessGrantsIdentityCenter

      default CompletableFuture<AssociateAccessGrantsIdentityCenterResponse> associateAccessGrantsIdentityCenter(Consumer<AssociateAccessGrantsIdentityCenterRequest.Builder> associateAccessGrantsIdentityCenterRequest)

      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, and sso:PutApplicationAuthenticationMethod.


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

      Parameters:
      associateAccessGrantsIdentityCenterRequest - A Consumer that will call methods on AssociateAccessGrantsIdentityCenterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateAccessGrantsIdentityCenter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrant

      default CompletableFuture<CreateAccessGrantResponse> createAccessGrant(CreateAccessGrantRequest createAccessGrantRequest)

      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 and sso:DescribeApplication

      For directory users - identitystore:DescribeUser

      For directory groups - identitystore:DescribeGroup

      Parameters:
      createAccessGrantRequest -
      Returns:
      A Java Future containing the result of the CreateAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrant

      default CompletableFuture<CreateAccessGrantResponse> createAccessGrant(Consumer<CreateAccessGrantRequest.Builder> createAccessGrantRequest)

      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 and sso: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 via CreateAccessGrantRequest.builder()

      Parameters:
      createAccessGrantRequest - A Consumer that will call methods on CreateAccessGrantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrantsInstance

      default CompletableFuture<CreateAccessGrantsInstanceResponse> createAccessGrantsInstance(CreateAccessGrantsInstanceRequest createAccessGrantsInstanceRequest)

      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, and sso:PutApplicationAuthenticationMethod permissions.

      Parameters:
      createAccessGrantsInstanceRequest -
      Returns:
      A Java Future containing the result of the CreateAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrantsInstance

      default CompletableFuture<CreateAccessGrantsInstanceResponse> createAccessGrantsInstance(Consumer<CreateAccessGrantsInstanceRequest.Builder> createAccessGrantsInstanceRequest)

      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, and sso:PutApplicationAuthenticationMethod permissions.


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

      Parameters:
      createAccessGrantsInstanceRequest - A Consumer that will call methods on CreateAccessGrantsInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrantsLocation

      default CompletableFuture<CreateAccessGrantsLocationResponse> createAccessGrantsLocation(CreateAccessGrantsLocationRequest createAccessGrantsLocationRequest)

      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:
      A Java Future containing the result of the CreateAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessGrantsLocation

      default CompletableFuture<CreateAccessGrantsLocationResponse> createAccessGrantsLocation(Consumer<CreateAccessGrantsLocationRequest.Builder> createAccessGrantsLocationRequest)

      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 via CreateAccessGrantsLocationRequest.builder()

      Parameters:
      createAccessGrantsLocationRequest - A Consumer that will call methods on CreateAccessGrantsLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPoint

      default CompletableFuture<CreateAccessPointResponse> createAccessPoint(CreateAccessPointRequest createAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to CreateAccessPoint:

      Parameters:
      createAccessPointRequest -
      Returns:
      A Java Future containing the result of the CreateAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPoint

      default CompletableFuture<CreateAccessPointResponse> createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to CreateAccessPoint:


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

      Parameters:
      createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPointForObjectLambda

      default CompletableFuture<CreateAccessPointForObjectLambdaResponse> createAccessPointForObjectLambda(CreateAccessPointForObjectLambdaRequest createAccessPointForObjectLambdaRequest)

      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:
      A Java Future containing the result of the CreateAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPointForObjectLambda

      default CompletableFuture<CreateAccessPointForObjectLambdaResponse> createAccessPointForObjectLambda(Consumer<CreateAccessPointForObjectLambdaRequest.Builder> createAccessPointForObjectLambdaRequest)

      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 via CreateAccessPointForObjectLambdaRequest.builder()

      Parameters:
      createAccessPointForObjectLambdaRequest - A Consumer that will call methods on CreateAccessPointForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucket

      default CompletableFuture<CreateBucketResponse> createBucket(CreateBucketRequest createBucketRequest)

      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:
      A Java Future containing the result of the CreateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BucketAlreadyExistsException The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the Outposts in this Region. Select a different name and try again.
      • BucketAlreadyOwnedByYouException The Outposts bucket you tried to create already exists, and you own it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucket

      default CompletableFuture<CreateBucketResponse> createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)

      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 via CreateBucketRequest.builder()

      Parameters:
      createBucketRequest - A Consumer that will call methods on CreateBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BucketAlreadyExistsException The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the Outposts in this Region. Select a different name and try again.
      • BucketAlreadyOwnedByYouException The Outposts bucket you tried to create already exists, and you own it.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)

      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:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsException
      • BadRequestException
      • IdempotencyException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)

      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 via CreateJobRequest.builder()

      Parameters:
      createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsException
      • BadRequestException
      • IdempotencyException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMultiRegionAccessPoint

      default CompletableFuture<CreateMultiRegionAccessPointResponse> createMultiRegionAccessPoint(CreateMultiRegionAccessPointRequest createMultiRegionAccessPointRequest)

      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:
      A Java Future containing the result of the CreateMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMultiRegionAccessPoint

      default CompletableFuture<CreateMultiRegionAccessPointResponse> createMultiRegionAccessPoint(Consumer<CreateMultiRegionAccessPointRequest.Builder> createMultiRegionAccessPointRequest)

      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 via CreateMultiRegionAccessPointRequest.builder()

      Parameters:
      createMultiRegionAccessPointRequest - A Consumer that will call methods on CreateMultiRegionAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorageLensGroup

      default CompletableFuture<CreateStorageLensGroupResponse> createStorageLensGroup(CreateStorageLensGroupRequest createStorageLensGroupRequest)

      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 the s3: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:
      A Java Future containing the result of the CreateStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorageLensGroup

      default CompletableFuture<CreateStorageLensGroupResponse> createStorageLensGroup(Consumer<CreateStorageLensGroupRequest.Builder> createStorageLensGroupRequest)

      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 the s3: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 via CreateStorageLensGroupRequest.builder()

      Parameters:
      createStorageLensGroupRequest - A Consumer that will call methods on CreateStorageLensGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrant

      default CompletableFuture<DeleteAccessGrantResponse> deleteAccessGrant(DeleteAccessGrantRequest deleteAccessGrantRequest)

      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:
      A Java Future containing the result of the DeleteAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrant

      default CompletableFuture<DeleteAccessGrantResponse> deleteAccessGrant(Consumer<DeleteAccessGrantRequest.Builder> deleteAccessGrantRequest)

      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 via DeleteAccessGrantRequest.builder()

      Parameters:
      deleteAccessGrantRequest - A Consumer that will call methods on DeleteAccessGrantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsInstance

      default CompletableFuture<DeleteAccessGrantsInstanceResponse> deleteAccessGrantsInstance(DeleteAccessGrantsInstanceRequest deleteAccessGrantsInstanceRequest)

      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:
      A Java Future containing the result of the DeleteAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsInstance

      default CompletableFuture<DeleteAccessGrantsInstanceResponse> deleteAccessGrantsInstance(Consumer<DeleteAccessGrantsInstanceRequest.Builder> deleteAccessGrantsInstanceRequest)

      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 via DeleteAccessGrantsInstanceRequest.builder()

      Parameters:
      deleteAccessGrantsInstanceRequest - A Consumer that will call methods on DeleteAccessGrantsInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsInstanceResourcePolicy

      default CompletableFuture<DeleteAccessGrantsInstanceResourcePolicyResponse> deleteAccessGrantsInstanceResourcePolicy(DeleteAccessGrantsInstanceResourcePolicyRequest deleteAccessGrantsInstanceResourcePolicyRequest)

      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:
      A Java Future containing the result of the DeleteAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsInstanceResourcePolicy

      default CompletableFuture<DeleteAccessGrantsInstanceResourcePolicyResponse> deleteAccessGrantsInstanceResourcePolicy(Consumer<DeleteAccessGrantsInstanceResourcePolicyRequest.Builder> deleteAccessGrantsInstanceResourcePolicyRequest)

      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 via DeleteAccessGrantsInstanceResourcePolicyRequest.builder()

      Parameters:
      deleteAccessGrantsInstanceResourcePolicyRequest - A Consumer that will call methods on DeleteAccessGrantsInstanceResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsLocation

      default CompletableFuture<DeleteAccessGrantsLocationResponse> deleteAccessGrantsLocation(DeleteAccessGrantsLocationRequest deleteAccessGrantsLocationRequest)

      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:
      A Java Future containing the result of the DeleteAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessGrantsLocation

      default CompletableFuture<DeleteAccessGrantsLocationResponse> deleteAccessGrantsLocation(Consumer<DeleteAccessGrantsLocationRequest.Builder> deleteAccessGrantsLocationRequest)

      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 via DeleteAccessGrantsLocationRequest.builder()

      Parameters:
      deleteAccessGrantsLocationRequest - A Consumer that will call methods on DeleteAccessGrantsLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPoint

      default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to DeleteAccessPoint:

      Parameters:
      deleteAccessPointRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPoint

      default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to DeleteAccessPoint:


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

      Parameters:
      deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointForObjectLambda

      default CompletableFuture<DeleteAccessPointForObjectLambdaResponse> deleteAccessPointForObjectLambda(DeleteAccessPointForObjectLambdaRequest deleteAccessPointForObjectLambdaRequest)

      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:
      A Java Future containing the result of the DeleteAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointForObjectLambda

      default CompletableFuture<DeleteAccessPointForObjectLambdaResponse> deleteAccessPointForObjectLambda(Consumer<DeleteAccessPointForObjectLambdaRequest.Builder> deleteAccessPointForObjectLambdaRequest)

      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 via DeleteAccessPointForObjectLambdaRequest.builder()

      Parameters:
      deleteAccessPointForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointPolicy

      default CompletableFuture<DeleteAccessPointPolicyResponse> deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to DeleteAccessPointPolicy:

      Parameters:
      deleteAccessPointPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointPolicy

      default CompletableFuture<DeleteAccessPointPolicyResponse> deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to DeleteAccessPointPolicy:


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

      Parameters:
      deleteAccessPointPolicyRequest - A Consumer that will call methods on DeleteAccessPointPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointPolicyForObjectLambda

      default CompletableFuture<DeleteAccessPointPolicyForObjectLambdaResponse> deleteAccessPointPolicyForObjectLambda(DeleteAccessPointPolicyForObjectLambdaRequest deleteAccessPointPolicyForObjectLambdaRequest)

      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:
      A Java Future containing the result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPointPolicyForObjectLambda

      default CompletableFuture<DeleteAccessPointPolicyForObjectLambdaResponse> deleteAccessPointPolicyForObjectLambda(Consumer<DeleteAccessPointPolicyForObjectLambdaRequest.Builder> deleteAccessPointPolicyForObjectLambdaRequest)

      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 via DeleteAccessPointPolicyForObjectLambdaRequest.builder()

      Parameters:
      deleteAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on DeleteAccessPointPolicyForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucket

      default CompletableFuture<DeleteBucketResponse> deleteBucket(DeleteBucketRequest deleteBucketRequest)

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

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

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

      Related Resources

      Parameters:
      deleteBucketRequest -
      Returns:
      A Java Future containing the result of the DeleteBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucket

      default CompletableFuture<DeleteBucketResponse> deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)

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

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

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

      Related Resources


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

      Parameters:
      deleteBucketRequest - A Consumer that will call methods on DeleteBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketLifecycleConfiguration

      default CompletableFuture<DeleteBucketLifecycleConfigurationResponse> deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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

      Related actions include:

      Parameters:
      deleteBucketLifecycleConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketLifecycleConfiguration

      default CompletableFuture<DeleteBucketLifecycleConfigurationResponse> deleteBucketLifecycleConfiguration(Consumer<DeleteBucketLifecycleConfigurationRequest.Builder> deleteBucketLifecycleConfigurationRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

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

      Related actions include:


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

      Parameters:
      deleteBucketLifecycleConfigurationRequest - A Consumer that will call methods on DeleteBucketLifecycleConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketPolicy

      default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)

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

      This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

      If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

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

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

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

      The following actions are related to DeleteBucketPolicy:

      Parameters:
      deleteBucketPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketPolicy

      default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)

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

      This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

      If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

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

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

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

      The following actions are related to DeleteBucketPolicy:


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

      Parameters:
      deleteBucketPolicyRequest - A Consumer that will call methods on DeleteBucketPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketReplication

      default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)

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

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

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

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

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

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

      The following operations are related to DeleteBucketReplication:

      Parameters:
      deleteBucketReplicationRequest -
      Returns:
      A Java Future containing the result of the DeleteBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketReplication

      default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)

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

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

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

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

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

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

      The following operations are related to DeleteBucketReplication:


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

      Parameters:
      deleteBucketReplicationRequest - A Consumer that will call methods on DeleteBucketReplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketTagging

      default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)

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

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

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

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

      The following actions are related to DeleteBucketTagging:

      Parameters:
      deleteBucketTaggingRequest -
      Returns:
      A Java Future containing the result of the DeleteBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketTagging

      default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)

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

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

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

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

      The following actions are related to DeleteBucketTagging:


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

      Parameters:
      deleteBucketTaggingRequest - A Consumer that will call methods on DeleteBucketTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteJobTagging

      default CompletableFuture<DeleteJobTaggingResponse> deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)

      Removes the entire tag set from the specified S3 Batch Operations job.

      Permissions

      To use the DeleteJobTagging operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

      Related actions include:

      Parameters:
      deleteJobTaggingRequest -
      Returns:
      A Java Future containing the result of the DeleteJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteJobTagging

      default CompletableFuture<DeleteJobTaggingResponse> deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)

      Removes the entire tag set from the specified S3 Batch Operations job.

      Permissions

      To use the DeleteJobTagging operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

      Related actions include:


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

      Parameters:
      deleteJobTaggingRequest - A Consumer that will call methods on DeleteJobTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMultiRegionAccessPoint

      default CompletableFuture<DeleteMultiRegionAccessPointResponse> deleteMultiRegionAccessPoint(DeleteMultiRegionAccessPointRequest deleteMultiRegionAccessPointRequest)

      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:
      A Java Future containing the result of the DeleteMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMultiRegionAccessPoint

      default CompletableFuture<DeleteMultiRegionAccessPointResponse> deleteMultiRegionAccessPoint(Consumer<DeleteMultiRegionAccessPointRequest.Builder> deleteMultiRegionAccessPointRequest)

      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 via DeleteMultiRegionAccessPointRequest.builder()

      Parameters:
      deleteMultiRegionAccessPointRequest - A Consumer that will call methods on DeleteMultiRegionAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePublicAccessBlock

      default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)

      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:
      A Java Future containing the result of the DeletePublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePublicAccessBlock

      default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)

      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 via DeletePublicAccessBlockRequest.builder()

      Parameters:
      deletePublicAccessBlockRequest - A Consumer that will call methods on DeletePublicAccessBlockRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensConfiguration

      default CompletableFuture<DeleteStorageLensConfigurationResponse> deleteStorageLensConfiguration(DeleteStorageLensConfigurationRequest deleteStorageLensConfigurationRequest)

      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:
      A Java Future containing the result of the DeleteStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensConfiguration

      default CompletableFuture<DeleteStorageLensConfigurationResponse> deleteStorageLensConfiguration(Consumer<DeleteStorageLensConfigurationRequest.Builder> deleteStorageLensConfigurationRequest)

      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 via DeleteStorageLensConfigurationRequest.builder()

      Parameters:
      deleteStorageLensConfigurationRequest - A Consumer that will call methods on DeleteStorageLensConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensConfigurationTagging

      default CompletableFuture<DeleteStorageLensConfigurationTaggingResponse> deleteStorageLensConfigurationTagging(DeleteStorageLensConfigurationTaggingRequest deleteStorageLensConfigurationTaggingRequest)

      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:
      A Java Future containing the result of the DeleteStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensConfigurationTagging

      default CompletableFuture<DeleteStorageLensConfigurationTaggingResponse> deleteStorageLensConfigurationTagging(Consumer<DeleteStorageLensConfigurationTaggingRequest.Builder> deleteStorageLensConfigurationTaggingRequest)

      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 via DeleteStorageLensConfigurationTaggingRequest.builder()

      Parameters:
      deleteStorageLensConfigurationTaggingRequest - A Consumer that will call methods on DeleteStorageLensConfigurationTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensGroup

      default CompletableFuture<DeleteStorageLensGroupResponse> deleteStorageLensGroup(DeleteStorageLensGroupRequest deleteStorageLensGroupRequest)

      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:
      A Java Future containing the result of the DeleteStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageLensGroup

      default CompletableFuture<DeleteStorageLensGroupResponse> deleteStorageLensGroup(Consumer<DeleteStorageLensGroupRequest.Builder> deleteStorageLensGroupRequest)

      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 via DeleteStorageLensGroupRequest.builder()

      Parameters:
      deleteStorageLensGroupRequest - A Consumer that will call methods on DeleteStorageLensGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeJob

      default CompletableFuture<DescribeJobResponse> describeJob(DescribeJobRequest describeJobRequest)

      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 the s3:DescribeJob action.

      Related actions include:

      Parameters:
      describeJobRequest -
      Returns:
      A Java Future containing the result of the DescribeJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeJob

      default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)

      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 the s3:DescribeJob action.

      Related actions include:


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

      Parameters:
      describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMultiRegionAccessPointOperation

      default CompletableFuture<DescribeMultiRegionAccessPointOperationResponse> describeMultiRegionAccessPointOperation(DescribeMultiRegionAccessPointOperationRequest describeMultiRegionAccessPointOperationRequest)

      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:
      A Java Future containing the result of the DescribeMultiRegionAccessPointOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMultiRegionAccessPointOperation

      default CompletableFuture<DescribeMultiRegionAccessPointOperationResponse> describeMultiRegionAccessPointOperation(Consumer<DescribeMultiRegionAccessPointOperationRequest.Builder> describeMultiRegionAccessPointOperationRequest)

      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 via DescribeMultiRegionAccessPointOperationRequest.builder()

      Parameters:
      describeMultiRegionAccessPointOperationRequest - A Consumer that will call methods on DescribeMultiRegionAccessPointOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMultiRegionAccessPointOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dissociateAccessGrantsIdentityCenter

      default CompletableFuture<DissociateAccessGrantsIdentityCenterResponse> dissociateAccessGrantsIdentityCenter(DissociateAccessGrantsIdentityCenterRequest dissociateAccessGrantsIdentityCenterRequest)

      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:
      A Java Future containing the result of the DissociateAccessGrantsIdentityCenter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dissociateAccessGrantsIdentityCenter

      default CompletableFuture<DissociateAccessGrantsIdentityCenterResponse> dissociateAccessGrantsIdentityCenter(Consumer<DissociateAccessGrantsIdentityCenterRequest.Builder> dissociateAccessGrantsIdentityCenterRequest)

      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 via DissociateAccessGrantsIdentityCenterRequest.builder()

      Parameters:
      dissociateAccessGrantsIdentityCenterRequest - A Consumer that will call methods on DissociateAccessGrantsIdentityCenterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DissociateAccessGrantsIdentityCenter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrant

      default CompletableFuture<GetAccessGrantResponse> getAccessGrant(GetAccessGrantRequest getAccessGrantRequest)

      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:
      A Java Future containing the result of the GetAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrant

      default CompletableFuture<GetAccessGrantResponse> getAccessGrant(Consumer<GetAccessGrantRequest.Builder> getAccessGrantRequest)

      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 via GetAccessGrantRequest.builder()

      Parameters:
      getAccessGrantRequest - A Consumer that will call methods on GetAccessGrantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessGrant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstance

      default CompletableFuture<GetAccessGrantsInstanceResponse> getAccessGrantsInstance(GetAccessGrantsInstanceRequest getAccessGrantsInstanceRequest)

      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:
      A Java Future containing the result of the GetAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstance

      default CompletableFuture<GetAccessGrantsInstanceResponse> getAccessGrantsInstance(Consumer<GetAccessGrantsInstanceRequest.Builder> getAccessGrantsInstanceRequest)

      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 via GetAccessGrantsInstanceRequest.builder()

      Parameters:
      getAccessGrantsInstanceRequest - A Consumer that will call methods on GetAccessGrantsInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessGrantsInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstanceForPrefix

      default CompletableFuture<GetAccessGrantsInstanceForPrefixResponse> getAccessGrantsInstanceForPrefix(GetAccessGrantsInstanceForPrefixRequest getAccessGrantsInstanceForPrefixRequest)

      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:
      A Java Future containing the result of the GetAccessGrantsInstanceForPrefix operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstanceForPrefix

      default CompletableFuture<GetAccessGrantsInstanceForPrefixResponse> getAccessGrantsInstanceForPrefix(Consumer<GetAccessGrantsInstanceForPrefixRequest.Builder> getAccessGrantsInstanceForPrefixRequest)

      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 via GetAccessGrantsInstanceForPrefixRequest.builder()

      Parameters:
      getAccessGrantsInstanceForPrefixRequest - A Consumer that will call methods on GetAccessGrantsInstanceForPrefixRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessGrantsInstanceForPrefix operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstanceResourcePolicy

      default CompletableFuture<GetAccessGrantsInstanceResourcePolicyResponse> getAccessGrantsInstanceResourcePolicy(GetAccessGrantsInstanceResourcePolicyRequest getAccessGrantsInstanceResourcePolicyRequest)

      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:
      A Java Future containing the result of the GetAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsInstanceResourcePolicy

      default CompletableFuture<GetAccessGrantsInstanceResourcePolicyResponse> getAccessGrantsInstanceResourcePolicy(Consumer<GetAccessGrantsInstanceResourcePolicyRequest.Builder> getAccessGrantsInstanceResourcePolicyRequest)

      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 via GetAccessGrantsInstanceResourcePolicyRequest.builder()

      Parameters:
      getAccessGrantsInstanceResourcePolicyRequest - A Consumer that will call methods on GetAccessGrantsInstanceResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsLocation

      default CompletableFuture<GetAccessGrantsLocationResponse> getAccessGrantsLocation(GetAccessGrantsLocationRequest getAccessGrantsLocationRequest)

      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:
      A Java Future containing the result of the GetAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessGrantsLocation

      default CompletableFuture<GetAccessGrantsLocationResponse> getAccessGrantsLocation(Consumer<GetAccessGrantsLocationRequest.Builder> getAccessGrantsLocationRequest)

      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 via GetAccessGrantsLocationRequest.builder()

      Parameters:
      getAccessGrantsLocationRequest - A Consumer that will call methods on GetAccessGrantsLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPoint

      default CompletableFuture<GetAccessPointResponse> getAccessPoint(GetAccessPointRequest getAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to GetAccessPoint:

      Parameters:
      getAccessPointRequest -
      Returns:
      A Java Future containing the result of the GetAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPoint

      default CompletableFuture<GetAccessPointResponse> getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to GetAccessPoint:


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

      Parameters:
      getAccessPointRequest - A Consumer that will call methods on GetAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointConfigurationForObjectLambda

      default CompletableFuture<GetAccessPointConfigurationForObjectLambdaResponse> getAccessPointConfigurationForObjectLambda(GetAccessPointConfigurationForObjectLambdaRequest getAccessPointConfigurationForObjectLambdaRequest)

      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:
      A Java Future containing the result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointConfigurationForObjectLambda

      default CompletableFuture<GetAccessPointConfigurationForObjectLambdaResponse> getAccessPointConfigurationForObjectLambda(Consumer<GetAccessPointConfigurationForObjectLambdaRequest.Builder> getAccessPointConfigurationForObjectLambdaRequest)

      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 via GetAccessPointConfigurationForObjectLambdaRequest.builder()

      Parameters:
      getAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointConfigurationForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointForObjectLambda

      default CompletableFuture<GetAccessPointForObjectLambdaResponse> getAccessPointForObjectLambda(GetAccessPointForObjectLambdaRequest getAccessPointForObjectLambdaRequest)

      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:
      A Java Future containing the result of the GetAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointForObjectLambda

      default CompletableFuture<GetAccessPointForObjectLambdaResponse> getAccessPointForObjectLambda(Consumer<GetAccessPointForObjectLambdaRequest.Builder> getAccessPointForObjectLambdaRequest)

      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 via GetAccessPointForObjectLambdaRequest.builder()

      Parameters:
      getAccessPointForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicy

      default CompletableFuture<GetAccessPointPolicyResponse> getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)

      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:
      A Java Future containing the result of the GetAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicy

      default CompletableFuture<GetAccessPointPolicyResponse> getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)

      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 via GetAccessPointPolicyRequest.builder()

      Parameters:
      getAccessPointPolicyRequest - A Consumer that will call methods on GetAccessPointPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyForObjectLambda

      default CompletableFuture<GetAccessPointPolicyForObjectLambdaResponse> getAccessPointPolicyForObjectLambda(GetAccessPointPolicyForObjectLambdaRequest getAccessPointPolicyForObjectLambdaRequest)

      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:
      A Java Future containing the result of the GetAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyForObjectLambda

      default CompletableFuture<GetAccessPointPolicyForObjectLambdaResponse> getAccessPointPolicyForObjectLambda(Consumer<GetAccessPointPolicyForObjectLambdaRequest.Builder> getAccessPointPolicyForObjectLambdaRequest)

      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 via GetAccessPointPolicyForObjectLambdaRequest.builder()

      Parameters:
      getAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointPolicyForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyStatus

      default CompletableFuture<GetAccessPointPolicyStatusResponse> getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)

      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:
      A Java Future containing the result of the GetAccessPointPolicyStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyStatus

      default CompletableFuture<GetAccessPointPolicyStatusResponse> getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)

      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 via GetAccessPointPolicyStatusRequest.builder()

      Parameters:
      getAccessPointPolicyStatusRequest - A Consumer that will call methods on GetAccessPointPolicyStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointPolicyStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyStatusForObjectLambda

      default CompletableFuture<GetAccessPointPolicyStatusForObjectLambdaResponse> getAccessPointPolicyStatusForObjectLambda(GetAccessPointPolicyStatusForObjectLambdaRequest getAccessPointPolicyStatusForObjectLambdaRequest)

      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:
      A Java Future containing the result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPointPolicyStatusForObjectLambda

      default CompletableFuture<GetAccessPointPolicyStatusForObjectLambdaResponse> getAccessPointPolicyStatusForObjectLambda(Consumer<GetAccessPointPolicyStatusForObjectLambdaRequest.Builder> getAccessPointPolicyStatusForObjectLambdaRequest)

      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 via GetAccessPointPolicyStatusForObjectLambdaRequest.builder()

      Parameters:
      getAccessPointPolicyStatusForObjectLambdaRequest - A Consumer that will call methods on GetAccessPointPolicyStatusForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPointPolicyStatusForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucket

      default CompletableFuture<GetBucketResponse> getBucket(GetBucketRequest getBucketRequest)

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

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

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

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

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

      Parameters:
      getBucketRequest -
      Returns:
      A Java Future containing the result of the GetBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucket

      default CompletableFuture<GetBucketResponse> getBucket(Consumer<GetBucketRequest.Builder> getBucketRequest)

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

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

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

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

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


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

      Parameters:
      getBucketRequest - A Consumer that will call methods on GetBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketLifecycleConfiguration

      default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)

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

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

      To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

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

      GetBucketLifecycleConfiguration has the following special error:

      • Error code: NoSuchLifecycleConfiguration

        • Description: The lifecycle configuration does not exist.

        • HTTP Status Code: 404 Not Found

        • SOAP Fault Code Prefix: Client

      The following actions are related to GetBucketLifecycleConfiguration:

      Parameters:
      getBucketLifecycleConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketLifecycleConfiguration

      default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)

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

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

      To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

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

      GetBucketLifecycleConfiguration has the following special error:

      • Error code: NoSuchLifecycleConfiguration

        • Description: The lifecycle configuration does not exist.

        • HTTP Status Code: 404 Not Found

        • SOAP Fault Code Prefix: Client

      The following actions are related to GetBucketLifecycleConfiguration:


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

      Parameters:
      getBucketLifecycleConfigurationRequest - A Consumer that will call methods on GetBucketLifecycleConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketPolicy

      default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)

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

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

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

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

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

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

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

      The following actions are related to GetBucketPolicy:

      Parameters:
      getBucketPolicyRequest -
      Returns:
      A Java Future containing the result of the GetBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketPolicy

      default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)

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

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

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

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

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

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

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

      The following actions are related to GetBucketPolicy:


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

      Parameters:
      getBucketPolicyRequest - A Consumer that will call methods on GetBucketPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketReplication

      default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)

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

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

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

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

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

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

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

      The following operations are related to GetBucketReplication:

      Parameters:
      getBucketReplicationRequest -
      Returns:
      A Java Future containing the result of the GetBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketReplication

      default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)

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

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

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

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

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

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

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

      The following operations are related to GetBucketReplication:


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

      Parameters:
      getBucketReplicationRequest - A Consumer that will call methods on GetBucketReplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketTagging

      default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)

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

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

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

      GetBucketTagging has the following special error:

      • Error code: NoSuchTagSetError

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

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

      The following actions are related to GetBucketTagging:

      Parameters:
      getBucketTaggingRequest -
      Returns:
      A Java Future containing the result of the GetBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketTagging

      default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)

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

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

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

      GetBucketTagging has the following special error:

      • Error code: NoSuchTagSetError

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

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

      The following actions are related to GetBucketTagging:


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

      Parameters:
      getBucketTaggingRequest - A Consumer that will call methods on GetBucketTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketVersioning

      default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)

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

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

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

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

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

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

      Parameters:
      getBucketVersioningRequest -
      Returns:
      A Java Future containing the result of the GetBucketVersioning operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketVersioning

      default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)

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

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

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

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

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

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


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

      Parameters:
      getBucketVersioningRequest - A Consumer that will call methods on GetBucketVersioningRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketVersioning operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataAccess

      default CompletableFuture<GetDataAccessResponse> getDataAccess(GetDataAccessRequest getDataAccessRequest)

      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 groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.

      Parameters:
      getDataAccessRequest -
      Returns:
      A Java Future containing the result of the GetDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataAccess

      default CompletableFuture<GetDataAccessResponse> getDataAccess(Consumer<GetDataAccessRequest.Builder> getDataAccessRequest)

      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 groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.


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

      Parameters:
      getDataAccessRequest - A Consumer that will call methods on GetDataAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobTagging

      default CompletableFuture<GetJobTaggingResponse> getJobTagging(GetJobTaggingRequest getJobTaggingRequest)

      Returns the tags on an S3 Batch Operations job.

      Permissions

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

      Related actions include:

      Parameters:
      getJobTaggingRequest -
      Returns:
      A Java Future containing the result of the GetJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobTagging

      default CompletableFuture<GetJobTaggingResponse> getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)

      Returns the tags on an S3 Batch Operations job.

      Permissions

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

      Related actions include:


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

      Parameters:
      getJobTaggingRequest - A Consumer that will call methods on GetJobTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPoint

      default CompletableFuture<GetMultiRegionAccessPointResponse> getMultiRegionAccessPoint(GetMultiRegionAccessPointRequest getMultiRegionAccessPointRequest)

      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:
      A Java Future containing the result of the GetMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPoint

      default CompletableFuture<GetMultiRegionAccessPointResponse> getMultiRegionAccessPoint(Consumer<GetMultiRegionAccessPointRequest.Builder> getMultiRegionAccessPointRequest)

      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 via GetMultiRegionAccessPointRequest.builder()

      Parameters:
      getMultiRegionAccessPointRequest - A Consumer that will call methods on GetMultiRegionAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMultiRegionAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointPolicy

      default CompletableFuture<GetMultiRegionAccessPointPolicyResponse> getMultiRegionAccessPointPolicy(GetMultiRegionAccessPointPolicyRequest getMultiRegionAccessPointPolicyRequest)

      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:
      A Java Future containing the result of the GetMultiRegionAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointPolicy

      default CompletableFuture<GetMultiRegionAccessPointPolicyResponse> getMultiRegionAccessPointPolicy(Consumer<GetMultiRegionAccessPointPolicyRequest.Builder> getMultiRegionAccessPointPolicyRequest)

      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 via GetMultiRegionAccessPointPolicyRequest.builder()

      Parameters:
      getMultiRegionAccessPointPolicyRequest - A Consumer that will call methods on GetMultiRegionAccessPointPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMultiRegionAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointPolicyStatus

      default CompletableFuture<GetMultiRegionAccessPointPolicyStatusResponse> getMultiRegionAccessPointPolicyStatus(GetMultiRegionAccessPointPolicyStatusRequest getMultiRegionAccessPointPolicyStatusRequest)

      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:
      A Java Future containing the result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointPolicyStatus

      default CompletableFuture<GetMultiRegionAccessPointPolicyStatusResponse> getMultiRegionAccessPointPolicyStatus(Consumer<GetMultiRegionAccessPointPolicyStatusRequest.Builder> getMultiRegionAccessPointPolicyStatusRequest)

      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 via GetMultiRegionAccessPointPolicyStatusRequest.builder()

      Parameters:
      getMultiRegionAccessPointPolicyStatusRequest - A Consumer that will call methods on GetMultiRegionAccessPointPolicyStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMultiRegionAccessPointPolicyStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointRoutes

      default CompletableFuture<GetMultiRegionAccessPointRoutesResponse> getMultiRegionAccessPointRoutes(GetMultiRegionAccessPointRoutesRequest getMultiRegionAccessPointRoutesRequest)

      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:
      A Java Future containing the result of the GetMultiRegionAccessPointRoutes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMultiRegionAccessPointRoutes

      default CompletableFuture<GetMultiRegionAccessPointRoutesResponse> getMultiRegionAccessPointRoutes(Consumer<GetMultiRegionAccessPointRoutesRequest.Builder> getMultiRegionAccessPointRoutesRequest)

      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 via GetMultiRegionAccessPointRoutesRequest.builder()

      Parameters:
      getMultiRegionAccessPointRoutesRequest - A Consumer that will call methods on GetMultiRegionAccessPointRoutesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMultiRegionAccessPointRoutes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPublicAccessBlock

      default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)

      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:
      A Java Future containing the result of the GetPublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NoSuchPublicAccessBlockConfigurationException Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPublicAccessBlock

      default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)

      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 via GetPublicAccessBlockRequest.builder()

      Parameters:
      getPublicAccessBlockRequest - A Consumer that will call methods on GetPublicAccessBlockRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NoSuchPublicAccessBlockConfigurationException Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensConfiguration

      default CompletableFuture<GetStorageLensConfigurationResponse> getStorageLensConfiguration(GetStorageLensConfigurationRequest getStorageLensConfigurationRequest)

      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:
      A Java Future containing the result of the GetStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensConfiguration

      default CompletableFuture<GetStorageLensConfigurationResponse> getStorageLensConfiguration(Consumer<GetStorageLensConfigurationRequest.Builder> getStorageLensConfigurationRequest)

      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 via GetStorageLensConfigurationRequest.builder()

      Parameters:
      getStorageLensConfigurationRequest - A Consumer that will call methods on GetStorageLensConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensConfigurationTagging

      default CompletableFuture<GetStorageLensConfigurationTaggingResponse> getStorageLensConfigurationTagging(GetStorageLensConfigurationTaggingRequest getStorageLensConfigurationTaggingRequest)

      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:
      A Java Future containing the result of the GetStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensConfigurationTagging

      default CompletableFuture<GetStorageLensConfigurationTaggingResponse> getStorageLensConfigurationTagging(Consumer<GetStorageLensConfigurationTaggingRequest.Builder> getStorageLensConfigurationTaggingRequest)

      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 via GetStorageLensConfigurationTaggingRequest.builder()

      Parameters:
      getStorageLensConfigurationTaggingRequest - A Consumer that will call methods on GetStorageLensConfigurationTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensGroup

      default CompletableFuture<GetStorageLensGroupResponse> getStorageLensGroup(GetStorageLensGroupRequest getStorageLensGroupRequest)

      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:
      A Java Future containing the result of the GetStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStorageLensGroup

      default CompletableFuture<GetStorageLensGroupResponse> getStorageLensGroup(Consumer<GetStorageLensGroupRequest.Builder> getStorageLensGroupRequest)

      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 via GetStorageLensGroupRequest.builder()

      Parameters:
      getStorageLensGroupRequest - A Consumer that will call methods on GetStorageLensGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrants

      default CompletableFuture<ListAccessGrantsResponse> listAccessGrants(ListAccessGrantsRequest listAccessGrantsRequest)

      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:
      A Java Future containing the result of the ListAccessGrants operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrants

      default CompletableFuture<ListAccessGrantsResponse> listAccessGrants(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest)

      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 via ListAccessGrantsRequest.builder()

      Parameters:
      listAccessGrantsRequest - A Consumer that will call methods on ListAccessGrantsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessGrants operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsInstances

      default CompletableFuture<ListAccessGrantsInstancesResponse> listAccessGrantsInstances(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest)

      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:
      A Java Future containing the result of the ListAccessGrantsInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsInstances

      default CompletableFuture<ListAccessGrantsInstancesResponse> listAccessGrantsInstances(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest)

      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 via ListAccessGrantsInstancesRequest.builder()

      Parameters:
      listAccessGrantsInstancesRequest - A Consumer that will call methods on ListAccessGrantsInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessGrantsInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsInstancesPaginator

      default ListAccessGrantsInstancesPublisher listAccessGrantsInstancesPaginator(ListAccessGrantsInstancesRequest listAccessGrantsInstancesRequest)

      This is a variant of listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesPublisher publisher = client.listAccessGrantsInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesPublisher publisher = client.listAccessGrantsInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsInstancesPaginator

      default ListAccessGrantsInstancesPublisher listAccessGrantsInstancesPaginator(Consumer<ListAccessGrantsInstancesRequest.Builder> listAccessGrantsInstancesRequest)

      This is a variant of listAccessGrantsInstances(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesPublisher publisher = client.listAccessGrantsInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsInstancesPublisher publisher = client.listAccessGrantsInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListAccessGrantsInstancesRequest.builder()

      Parameters:
      listAccessGrantsInstancesRequest - A Consumer that will call methods on ListAccessGrantsInstancesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsLocations

      default CompletableFuture<ListAccessGrantsLocationsResponse> listAccessGrantsLocations(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest)

      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:
      A Java Future containing the result of the ListAccessGrantsLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsLocations

      default CompletableFuture<ListAccessGrantsLocationsResponse> listAccessGrantsLocations(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest)

      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 via ListAccessGrantsLocationsRequest.builder()

      Parameters:
      listAccessGrantsLocationsRequest - A Consumer that will call methods on ListAccessGrantsLocationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessGrantsLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsLocationsPaginator

      default ListAccessGrantsLocationsPublisher listAccessGrantsLocationsPaginator(ListAccessGrantsLocationsRequest listAccessGrantsLocationsRequest)

      This is a variant of listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsPublisher publisher = client.listAccessGrantsLocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsPublisher publisher = client.listAccessGrantsLocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsLocationsPaginator

      default ListAccessGrantsLocationsPublisher listAccessGrantsLocationsPaginator(Consumer<ListAccessGrantsLocationsRequest.Builder> listAccessGrantsLocationsRequest)

      This is a variant of listAccessGrantsLocations(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsPublisher publisher = client.listAccessGrantsLocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsLocationsPublisher publisher = client.listAccessGrantsLocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListAccessGrantsLocationsRequest.builder()

      Parameters:
      listAccessGrantsLocationsRequest - A Consumer that will call methods on ListAccessGrantsLocationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsPaginator

      default ListAccessGrantsPublisher listAccessGrantsPaginator(ListAccessGrantsRequest listAccessGrantsRequest)

      This is a variant of listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessGrantsPaginator

      default ListAccessGrantsPublisher listAccessGrantsPaginator(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest)

      This is a variant of listAccessGrants(software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessGrantsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListAccessGrantsRequest.builder()

      Parameters:
      listAccessGrantsRequest - A Consumer that will call methods on ListAccessGrantsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoints

      default CompletableFuture<ListAccessPointsResponse> listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to ListAccessPoints:

      Parameters:
      listAccessPointsRequest -
      Returns:
      A Java Future containing the result of the ListAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoints

      default CompletableFuture<ListAccessPointsResponse> listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to ListAccessPoints:


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

      Parameters:
      listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsForObjectLambda

      default CompletableFuture<ListAccessPointsForObjectLambdaResponse> listAccessPointsForObjectLambda(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)

      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:
      A Java Future containing the result of the ListAccessPointsForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsForObjectLambda

      default CompletableFuture<ListAccessPointsForObjectLambdaResponse> listAccessPointsForObjectLambda(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)

      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 via ListAccessPointsForObjectLambdaRequest.builder()

      Parameters:
      listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessPointsForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsForObjectLambdaPaginator

      default ListAccessPointsForObjectLambdaPublisher listAccessPointsForObjectLambdaPaginator(ListAccessPointsForObjectLambdaRequest listAccessPointsForObjectLambdaRequest)

      This is a variant of listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaPublisher publisher = client.listAccessPointsForObjectLambdaPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaPublisher publisher = client.listAccessPointsForObjectLambdaPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsForObjectLambdaPaginator

      default ListAccessPointsForObjectLambdaPublisher listAccessPointsForObjectLambdaPaginator(Consumer<ListAccessPointsForObjectLambdaRequest.Builder> listAccessPointsForObjectLambdaRequest)

      This is a variant of listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaPublisher publisher = client.listAccessPointsForObjectLambdaPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsForObjectLambdaPublisher publisher = client.listAccessPointsForObjectLambdaPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccessPointsForObjectLambda(software.amazon.awssdk.services.s3control.model.ListAccessPointsForObjectLambdaRequest) operation.


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

      Parameters:
      listAccessPointsForObjectLambdaRequest - A Consumer that will call methods on ListAccessPointsForObjectLambdaRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsPaginator

      default ListAccessPointsPublisher listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)

      This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPointsPaginator

      default ListAccessPointsPublisher listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)

      This is a variant of listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.


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

      Parameters:
      listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<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. 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 the s3:ListJobs action.

      Related actions include:

      Parameters:
      listJobsRequest -
      Returns:
      A Java Future containing the result of the ListJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException
      • InternalServiceException
      • InvalidNextTokenException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<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. 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 the s3:ListJobs action.

      Related actions include:


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException
      • InternalServiceException
      • InvalidNextTokenException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException
      • InternalServiceException
      • InvalidNextTokenException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException
      • InternalServiceException
      • InvalidNextTokenException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMultiRegionAccessPoints

      default CompletableFuture<ListMultiRegionAccessPointsResponse> listMultiRegionAccessPoints(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)

      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:
      A Java Future containing the result of the ListMultiRegionAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMultiRegionAccessPoints

      default CompletableFuture<ListMultiRegionAccessPointsResponse> listMultiRegionAccessPoints(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)

      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 via ListMultiRegionAccessPointsRequest.builder()

      Parameters:
      listMultiRegionAccessPointsRequest - A Consumer that will call methods on ListMultiRegionAccessPointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMultiRegionAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMultiRegionAccessPointsPaginator

      default ListMultiRegionAccessPointsPublisher listMultiRegionAccessPointsPaginator(ListMultiRegionAccessPointsRequest listMultiRegionAccessPointsRequest)

      This is a variant of listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsPublisher publisher = client.listMultiRegionAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsPublisher publisher = client.listMultiRegionAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMultiRegionAccessPointsPaginator

      default ListMultiRegionAccessPointsPublisher listMultiRegionAccessPointsPaginator(Consumer<ListMultiRegionAccessPointsRequest.Builder> listMultiRegionAccessPointsRequest)

      This is a variant of listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsPublisher publisher = client.listMultiRegionAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListMultiRegionAccessPointsPublisher publisher = client.listMultiRegionAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMultiRegionAccessPoints(software.amazon.awssdk.services.s3control.model.ListMultiRegionAccessPointsRequest) operation.


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

      Parameters:
      listMultiRegionAccessPointsRequest - A Consumer that will call methods on ListMultiRegionAccessPointsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionalBuckets

      default CompletableFuture<ListRegionalBucketsResponse> listRegionalBuckets(ListRegionalBucketsRequest listRegionalBucketsRequest)

      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:
      A Java Future containing the result of the ListRegionalBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionalBuckets

      default CompletableFuture<ListRegionalBucketsResponse> listRegionalBuckets(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)

      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 via ListRegionalBucketsRequest.builder()

      Parameters:
      listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRegionalBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionalBucketsPaginator

      default ListRegionalBucketsPublisher listRegionalBucketsPaginator(ListRegionalBucketsRequest listRegionalBucketsRequest)

      This is a variant of listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsPublisher publisher = client.listRegionalBucketsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsPublisher publisher = client.listRegionalBucketsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegionalBucketsPaginator

      default ListRegionalBucketsPublisher listRegionalBucketsPaginator(Consumer<ListRegionalBucketsRequest.Builder> listRegionalBucketsRequest)

      This is a variant of listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsPublisher publisher = client.listRegionalBucketsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListRegionalBucketsPublisher publisher = client.listRegionalBucketsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listRegionalBuckets(software.amazon.awssdk.services.s3control.model.ListRegionalBucketsRequest) operation.


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

      Parameters:
      listRegionalBucketsRequest - A Consumer that will call methods on ListRegionalBucketsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensConfigurations

      default CompletableFuture<ListStorageLensConfigurationsResponse> listStorageLensConfigurations(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)

      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:
      A Java Future containing the result of the ListStorageLensConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensConfigurations

      default CompletableFuture<ListStorageLensConfigurationsResponse> listStorageLensConfigurations(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)

      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 via ListStorageLensConfigurationsRequest.builder()

      Parameters:
      listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStorageLensConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensConfigurationsPaginator

      default ListStorageLensConfigurationsPublisher listStorageLensConfigurationsPaginator(ListStorageLensConfigurationsRequest listStorageLensConfigurationsRequest)

      This is a variant of listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsPublisher publisher = client.listStorageLensConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsPublisher publisher = client.listStorageLensConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensConfigurationsPaginator

      default ListStorageLensConfigurationsPublisher listStorageLensConfigurationsPaginator(Consumer<ListStorageLensConfigurationsRequest.Builder> listStorageLensConfigurationsRequest)

      This is a variant of listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsPublisher publisher = client.listStorageLensConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensConfigurationsPublisher publisher = client.listStorageLensConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listStorageLensConfigurations(software.amazon.awssdk.services.s3control.model.ListStorageLensConfigurationsRequest) operation.


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

      Parameters:
      listStorageLensConfigurationsRequest - A Consumer that will call methods on ListStorageLensConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensGroups

      default CompletableFuture<ListStorageLensGroupsResponse> listStorageLensGroups(ListStorageLensGroupsRequest listStorageLensGroupsRequest)

      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:
      A Java Future containing the result of the ListStorageLensGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensGroups

      default CompletableFuture<ListStorageLensGroupsResponse> listStorageLensGroups(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest)

      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 via ListStorageLensGroupsRequest.builder()

      Parameters:
      listStorageLensGroupsRequest - A Consumer that will call methods on ListStorageLensGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStorageLensGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensGroupsPaginator

      default ListStorageLensGroupsPublisher listStorageLensGroupsPaginator(ListStorageLensGroupsRequest listStorageLensGroupsRequest)

      This is a variant of listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsPublisher publisher = client.listStorageLensGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsPublisher publisher = client.listStorageLensGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageLensGroupsPaginator

      default ListStorageLensGroupsPublisher listStorageLensGroupsPaginator(Consumer<ListStorageLensGroupsRequest.Builder> listStorageLensGroupsRequest)

      This is a variant of listStorageLensGroups(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsPublisher publisher = client.listStorageLensGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3control.paginators.ListStorageLensGroupsPublisher publisher = client.listStorageLensGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3control.model.ListStorageLensGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListStorageLensGroupsRequest.builder()

      Parameters:
      listStorageLensGroupsRequest - A Consumer that will call methods on ListStorageLensGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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 via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessGrantsInstanceResourcePolicy

      default CompletableFuture<PutAccessGrantsInstanceResourcePolicyResponse> putAccessGrantsInstanceResourcePolicy(PutAccessGrantsInstanceResourcePolicyRequest putAccessGrantsInstanceResourcePolicyRequest)

      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:
      A Java Future containing the result of the PutAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessGrantsInstanceResourcePolicy

      default CompletableFuture<PutAccessGrantsInstanceResourcePolicyResponse> putAccessGrantsInstanceResourcePolicy(Consumer<PutAccessGrantsInstanceResourcePolicyRequest.Builder> putAccessGrantsInstanceResourcePolicyRequest)

      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 via PutAccessGrantsInstanceResourcePolicyRequest.builder()

      Parameters:
      putAccessGrantsInstanceResourcePolicyRequest - A Consumer that will call methods on PutAccessGrantsInstanceResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccessGrantsInstanceResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointConfigurationForObjectLambda

      default CompletableFuture<PutAccessPointConfigurationForObjectLambdaResponse> putAccessPointConfigurationForObjectLambda(PutAccessPointConfigurationForObjectLambdaRequest putAccessPointConfigurationForObjectLambdaRequest)

      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:
      A Java Future containing the result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointConfigurationForObjectLambda

      default CompletableFuture<PutAccessPointConfigurationForObjectLambdaResponse> putAccessPointConfigurationForObjectLambda(Consumer<PutAccessPointConfigurationForObjectLambdaRequest.Builder> putAccessPointConfigurationForObjectLambdaRequest)

      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 via PutAccessPointConfigurationForObjectLambdaRequest.builder()

      Parameters:
      putAccessPointConfigurationForObjectLambdaRequest - A Consumer that will call methods on PutAccessPointConfigurationForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccessPointConfigurationForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointPolicy

      default CompletableFuture<PutAccessPointPolicyResponse> putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to PutAccessPointPolicy:

      Parameters:
      putAccessPointPolicyRequest -
      Returns:
      A Java Future containing the result of the PutAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointPolicy

      default CompletableFuture<PutAccessPointPolicyResponse> putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)

      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 of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

      The following actions are related to PutAccessPointPolicy:


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

      Parameters:
      putAccessPointPolicyRequest - A Consumer that will call methods on PutAccessPointPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointPolicyForObjectLambda

      default CompletableFuture<PutAccessPointPolicyForObjectLambdaResponse> putAccessPointPolicyForObjectLambda(PutAccessPointPolicyForObjectLambdaRequest putAccessPointPolicyForObjectLambdaRequest)

      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:
      A Java Future containing the result of the PutAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccessPointPolicyForObjectLambda

      default CompletableFuture<PutAccessPointPolicyForObjectLambdaResponse> putAccessPointPolicyForObjectLambda(Consumer<PutAccessPointPolicyForObjectLambdaRequest.Builder> putAccessPointPolicyForObjectLambdaRequest)

      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 via PutAccessPointPolicyForObjectLambdaRequest.builder()

      Parameters:
      putAccessPointPolicyForObjectLambdaRequest - A Consumer that will call methods on PutAccessPointPolicyForObjectLambdaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccessPointPolicyForObjectLambda operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketLifecycleConfiguration

      default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)

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

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

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

      The following actions are related to PutBucketLifecycleConfiguration:

      Parameters:
      putBucketLifecycleConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketLifecycleConfiguration

      default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)

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

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

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

      The following actions are related to PutBucketLifecycleConfiguration:


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

      Parameters:
      putBucketLifecycleConfigurationRequest - A Consumer that will call methods on PutBucketLifecycleConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBucketLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketPolicy

      default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)

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

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

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

      If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

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

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

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

      The following actions are related to PutBucketPolicy:

      Parameters:
      putBucketPolicyRequest -
      Returns:
      A Java Future containing the result of the PutBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketPolicy

      default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)

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

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

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

      If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

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

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

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

      The following actions are related to PutBucketPolicy:


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

      Parameters:
      putBucketPolicyRequest - A Consumer that will call methods on PutBucketPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketReplication

      default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)

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

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

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

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

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

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

      • Other relevant information, such as replication rules

      A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

      To specify a subset of the objects in the source Outposts bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

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

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

      Handling Replication of Encrypted Objects

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

      Permissions

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

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

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

      The following operations are related to PutBucketReplication:

      Parameters:
      putBucketReplicationRequest -
      Returns:
      A Java Future containing the result of the PutBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketReplication

      default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)

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

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

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

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

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

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

      • Other relevant information, such as replication rules

      A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

      To specify a subset of the objects in the source Outposts bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

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

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

      Handling Replication of Encrypted Objects

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

      Permissions

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

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

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

      The following operations are related to PutBucketReplication:


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

      Parameters:
      putBucketReplicationRequest - A Consumer that will call methods on PutBucketReplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBucketReplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketTagging

      default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)

      This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon 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

      • Error code: MalformedXMLError

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

      • Error code: OperationAbortedError

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

      • Error code: InternalError

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

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

      The following actions are related to PutBucketTagging:

      Parameters:
      putBucketTaggingRequest -
      Returns:
      A Java Future containing the result of the PutBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketTagging

      default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)

      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

      • Error code: MalformedXMLError

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

      • Error code: OperationAbortedError

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

      • Error code: InternalError

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

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

      The following actions are related to PutBucketTagging:


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

      Parameters:
      putBucketTaggingRequest - A Consumer that will call methods on PutBucketTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBucketTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketVersioning

      default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)

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

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

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

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

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

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

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

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

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

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

      Parameters:
      putBucketVersioningRequest -
      Returns:
      A Java Future containing the result of the PutBucketVersioning operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBucketVersioning

      default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)

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

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

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

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

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

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

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

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

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

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


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

      Parameters:
      putBucketVersioningRequest - A Consumer that will call methods on PutBucketVersioningRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBucketVersioning operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putJobTagging

      default CompletableFuture<PutJobTaggingResponse> putJobTagging(PutJobTaggingRequest putJobTaggingRequest)

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

      A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this 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 the s3:PutJobTagging action.

      Related actions include:

      Parameters:
      putJobTaggingRequest -
      Returns:
      A Java Future containing the result of the PutJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • TooManyTagsException Amazon S3 throws this exception if you have too many tags in your tag set.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putJobTagging

      default CompletableFuture<PutJobTaggingResponse> putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)

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

      A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this 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 the s3:PutJobTagging action.

      Related actions include:


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

      Parameters:
      putJobTaggingRequest - A Consumer that will call methods on PutJobTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutJobTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException
      • TooManyRequestsException
      • NotFoundException
      • TooManyTagsException Amazon S3 throws this exception if you have too many tags in your tag set.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMultiRegionAccessPointPolicy

      default CompletableFuture<PutMultiRegionAccessPointPolicyResponse> putMultiRegionAccessPointPolicy(PutMultiRegionAccessPointPolicyRequest putMultiRegionAccessPointPolicyRequest)

      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:
      A Java Future containing the result of the PutMultiRegionAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMultiRegionAccessPointPolicy

      default CompletableFuture<PutMultiRegionAccessPointPolicyResponse> putMultiRegionAccessPointPolicy(Consumer<PutMultiRegionAccessPointPolicyRequest.Builder> putMultiRegionAccessPointPolicyRequest)

      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 via PutMultiRegionAccessPointPolicyRequest.builder()

      Parameters:
      putMultiRegionAccessPointPolicyRequest - A Consumer that will call methods on PutMultiRegionAccessPointPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutMultiRegionAccessPointPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPublicAccessBlock

      default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)

      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 the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

      Related actions include:

      Parameters:
      putPublicAccessBlockRequest -
      Returns:
      A Java Future containing the result of the PutPublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPublicAccessBlock

      default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)

      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 the s3: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 via PutPublicAccessBlockRequest.builder()

      Parameters:
      putPublicAccessBlockRequest - A Consumer that will call methods on PutPublicAccessBlockRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutPublicAccessBlock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageLensConfiguration

      default CompletableFuture<PutStorageLensConfigurationResponse> putStorageLensConfiguration(PutStorageLensConfigurationRequest putStorageLensConfigurationRequest)

      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:
      A Java Future containing the result of the PutStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageLensConfiguration

      default CompletableFuture<PutStorageLensConfigurationResponse> putStorageLensConfiguration(Consumer<PutStorageLensConfigurationRequest.Builder> putStorageLensConfigurationRequest)

      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 via PutStorageLensConfigurationRequest.builder()

      Parameters:
      putStorageLensConfigurationRequest - A Consumer that will call methods on PutStorageLensConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutStorageLensConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageLensConfigurationTagging

      default CompletableFuture<PutStorageLensConfigurationTaggingResponse> putStorageLensConfigurationTagging(PutStorageLensConfigurationTaggingRequest putStorageLensConfigurationTaggingRequest)

      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:
      A Java Future containing the result of the PutStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putStorageLensConfigurationTagging

      default CompletableFuture<PutStorageLensConfigurationTaggingResponse> putStorageLensConfigurationTagging(Consumer<PutStorageLensConfigurationTaggingRequest.Builder> putStorageLensConfigurationTaggingRequest)

      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 via PutStorageLensConfigurationTaggingRequest.builder()

      Parameters:
      putStorageLensConfigurationTaggingRequest - A Consumer that will call methods on PutStorageLensConfigurationTaggingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutStorageLensConfigurationTagging operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitMultiRegionAccessPointRoutes

      default CompletableFuture<SubmitMultiRegionAccessPointRoutesResponse> submitMultiRegionAccessPointRoutes(SubmitMultiRegionAccessPointRoutesRequest submitMultiRegionAccessPointRoutesRequest)

      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 of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

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

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

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

      • us-east-1

      • us-west-2

      • ap-southeast-2

      • ap-northeast-1

      • eu-west-1

      Parameters:
      submitMultiRegionAccessPointRoutesRequest -
      Returns:
      A Java Future containing the result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitMultiRegionAccessPointRoutes

      default CompletableFuture<SubmitMultiRegionAccessPointRoutesResponse> submitMultiRegionAccessPointRoutes(Consumer<SubmitMultiRegionAccessPointRoutesRequest.Builder> submitMultiRegionAccessPointRoutesRequest)

      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 of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

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

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

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

      • us-east-1

      • us-west-2

      • ap-southeast-2

      • ap-northeast-1

      • eu-west-1


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

      Parameters:
      submitMultiRegionAccessPointRoutesRequest - A Consumer that will call methods on SubmitMultiRegionAccessPointRoutesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitMultiRegionAccessPointRoutes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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 via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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 via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessGrantsLocation

      default CompletableFuture<UpdateAccessGrantsLocationResponse> updateAccessGrantsLocation(UpdateAccessGrantsLocationRequest updateAccessGrantsLocationRequest)

      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:
      A Java Future containing the result of the UpdateAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessGrantsLocation

      default CompletableFuture<UpdateAccessGrantsLocationResponse> updateAccessGrantsLocation(Consumer<UpdateAccessGrantsLocationRequest.Builder> updateAccessGrantsLocationRequest)

      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 via UpdateAccessGrantsLocationRequest.builder()

      Parameters:
      updateAccessGrantsLocationRequest - A Consumer that will call methods on UpdateAccessGrantsLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccessGrantsLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobPriority

      default CompletableFuture<UpdateJobPriorityResponse> updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)

      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 the s3:UpdateJobPriority action.

      Related actions include:

      Parameters:
      updateJobPriorityRequest -
      Returns:
      A Java Future containing the result of the UpdateJobPriority operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobPriority

      default CompletableFuture<UpdateJobPriorityResponse> updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)

      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 the s3:UpdateJobPriority action.

      Related actions include:


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

      Parameters:
      updateJobPriorityRequest - A Consumer that will call methods on UpdateJobPriorityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJobPriority operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobStatus

      default CompletableFuture<UpdateJobStatusResponse> updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)

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

      Permissions

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

      Related actions include:

      Parameters:
      updateJobStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateJobStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • JobStatusException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobStatus

      default CompletableFuture<UpdateJobStatusResponse> updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)

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

      Permissions

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

      Related actions include:


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

      Parameters:
      updateJobStatusRequest - A Consumer that will call methods on UpdateJobStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJobStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException
      • TooManyRequestsException
      • NotFoundException
      • JobStatusException
      • InternalServiceException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageLensGroup

      default CompletableFuture<UpdateStorageLensGroupResponse> updateStorageLensGroup(UpdateStorageLensGroupRequest updateStorageLensGroupRequest)

      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:
      A Java Future containing the result of the UpdateStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageLensGroup

      default CompletableFuture<UpdateStorageLensGroupResponse> updateStorageLensGroup(Consumer<UpdateStorageLensGroupRequest.Builder> updateStorageLensGroupRequest)

      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 via UpdateStorageLensGroupRequest.builder()

      Parameters:
      updateStorageLensGroupRequest - A Consumer that will call methods on UpdateStorageLensGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStorageLensGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3ControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default S3ControlServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static S3ControlAsyncClient create()
      Create a S3ControlAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static S3ControlAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a S3ControlAsyncClient.