Interface S3FilesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface S3FilesAsyncClient extends AwsClient
Service client for accessing Amazon S3 Files 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.

S3 Files makes S3 buckets accessible as high-performance file systems powered by EFS. This service enables file system interface access to S3 data with sub-millisecond latencies through mount targets, supporting AI/ML workloads, media processing, and hybrid storage workflows that require both file system and object storage access to the same data.

  • Field Details

  • Method Details

    • createAccessPoint

      default CompletableFuture<CreateAccessPointResponse> createAccessPoint(CreateAccessPointRequest createAccessPointRequest)

      Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest createFileSystemRequest)

      Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.

      Parameters:
      createFileSystemRequest -
      Returns:
      A Java Future containing the result of the CreateFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)

      Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.


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

      Parameters:
      createFileSystemRequest - A Consumer that will call methods on CreateFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMountTarget

      default CompletableFuture<CreateMountTargetResponse> createMountTarget(CreateMountTargetRequest createMountTargetRequest)

      Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.

      Parameters:
      createMountTargetRequest -
      Returns:
      A Java Future containing the result of the CreateMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMountTarget

      default CompletableFuture<CreateMountTargetResponse> createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)

      Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.


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

      Parameters:
      createMountTargetRequest - A Consumer that will call methods on CreateMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ServiceQuotaExceededException The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Deletes an S3 File System Access Point. This operation is irreversible.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Deletes an S3 File System Access Point. This operation is irreversible.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)

      Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.

      Parameters:
      deleteFileSystemRequest -
      Returns:
      A Java Future containing the result of the DeleteFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)

      Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.


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

      Parameters:
      deleteFileSystemRequest - A Consumer that will call methods on DeleteFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystemPolicy

      default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)

      Deletes the IAM resource policy of an S3 File System.

      Parameters:
      deleteFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystemPolicy

      default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)

      Deletes the IAM resource policy of an S3 File System.


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

      Parameters:
      deleteFileSystemPolicyRequest - A Consumer that will call methods on DeleteFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMountTarget

      default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)

      Deletes the specified mount target. This operation is irreversible.

      Parameters:
      deleteMountTargetRequest -
      Returns:
      A Java Future containing the result of the DeleteMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMountTarget

      default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)

      Deletes the specified mount target. This operation is irreversible.


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

      Parameters:
      deleteMountTargetRequest - A Consumer that will call methods on DeleteMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Returns resource information for an S3 File System Access Point.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Returns resource information for an S3 File System Access Point.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFileSystem

      default CompletableFuture<GetFileSystemResponse> getFileSystem(GetFileSystemRequest getFileSystemRequest)

      Returns resource information for the specified S3 File System including status, configuration, and metadata.

      Parameters:
      getFileSystemRequest -
      Returns:
      A Java Future containing the result of the GetFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFileSystem

      default CompletableFuture<GetFileSystemResponse> getFileSystem(Consumer<GetFileSystemRequest.Builder> getFileSystemRequest)

      Returns resource information for the specified S3 File System including status, configuration, and metadata.


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

      Parameters:
      getFileSystemRequest - A Consumer that will call methods on GetFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFileSystem 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFileSystemPolicy

      default CompletableFuture<GetFileSystemPolicyResponse> getFileSystemPolicy(GetFileSystemPolicyRequest getFileSystemPolicyRequest)

      Returns the IAM resource policy of an S3 File System.

      Parameters:
      getFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the GetFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFileSystemPolicy

      default CompletableFuture<GetFileSystemPolicyResponse> getFileSystemPolicy(Consumer<GetFileSystemPolicyRequest.Builder> getFileSystemPolicyRequest)

      Returns the IAM resource policy of an S3 File System.


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

      Parameters:
      getFileSystemPolicyRequest - A Consumer that will call methods on GetFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMountTarget

      default CompletableFuture<GetMountTargetResponse> getMountTarget(GetMountTargetRequest getMountTargetRequest)

      Returns detailed resource information for the specified mount target including network configuration.

      Parameters:
      getMountTargetRequest -
      Returns:
      A Java Future containing the result of the GetMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMountTarget

      default CompletableFuture<GetMountTargetResponse> getMountTarget(Consumer<GetMountTargetRequest.Builder> getMountTargetRequest)

      Returns detailed resource information for the specified mount target including network configuration.


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

      Parameters:
      getMountTargetRequest - A Consumer that will call methods on GetMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSynchronizationConfiguration

      default CompletableFuture<GetSynchronizationConfigurationResponse> getSynchronizationConfiguration(GetSynchronizationConfigurationRequest getSynchronizationConfigurationRequest)

      Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

      Parameters:
      getSynchronizationConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetSynchronizationConfiguration 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSynchronizationConfiguration

      default CompletableFuture<GetSynchronizationConfigurationResponse> getSynchronizationConfiguration(Consumer<GetSynchronizationConfigurationRequest.Builder> getSynchronizationConfigurationRequest)

      Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.


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

      Parameters:
      getSynchronizationConfigurationRequest - A Consumer that will call methods on GetSynchronizationConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSynchronizationConfiguration 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Returns resource information for all S3 File System Access Points associated with the specified S3 File System.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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.s3files.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.s3files.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.s3files.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.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.s3files.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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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.s3files.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.s3files.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.s3files.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.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.s3files.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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystems

      default CompletableFuture<ListFileSystemsResponse> listFileSystems(ListFileSystemsRequest listFileSystemsRequest)

      Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.

      Parameters:
      listFileSystemsRequest -
      Returns:
      A Java Future containing the result of the ListFileSystems 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystems

      default CompletableFuture<ListFileSystemsResponse> listFileSystems(Consumer<ListFileSystemsRequest.Builder> listFileSystemsRequest)

      Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.


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

      Parameters:
      listFileSystemsRequest - A Consumer that will call methods on ListFileSystemsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFileSystems 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemsPaginator

      default ListFileSystemsPublisher listFileSystemsPaginator(ListFileSystemsRequest listFileSystemsRequest)

      This is a variant of listFileSystems(software.amazon.awssdk.services.s3files.model.ListFileSystemsRequest) 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.s3files.paginators.ListFileSystemsPublisher publisher = client.listFileSystemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListFileSystemsPublisher publisher = client.listFileSystemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListFileSystemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListFileSystemsResponse 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 listFileSystems(software.amazon.awssdk.services.s3files.model.ListFileSystemsRequest) operation.

      Parameters:
      listFileSystemsRequest -
      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemsPaginator

      default ListFileSystemsPublisher listFileSystemsPaginator(Consumer<ListFileSystemsRequest.Builder> listFileSystemsRequest)

      This is a variant of listFileSystems(software.amazon.awssdk.services.s3files.model.ListFileSystemsRequest) 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.s3files.paginators.ListFileSystemsPublisher publisher = client.listFileSystemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListFileSystemsPublisher publisher = client.listFileSystemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListFileSystemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListFileSystemsResponse 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 listFileSystems(software.amazon.awssdk.services.s3files.model.ListFileSystemsRequest) operation.


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

      Parameters:
      listFileSystemsRequest - A Consumer that will call methods on ListFileSystemsRequest.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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMountTargets

      default CompletableFuture<ListMountTargetsResponse> listMountTargets(ListMountTargetsRequest listMountTargetsRequest)

      Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

      Parameters:
      listMountTargetsRequest -
      Returns:
      A Java Future containing the result of the ListMountTargets 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMountTargets

      default CompletableFuture<ListMountTargetsResponse> listMountTargets(Consumer<ListMountTargetsRequest.Builder> listMountTargetsRequest)

      Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.


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

      Parameters:
      listMountTargetsRequest - A Consumer that will call methods on ListMountTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMountTargets 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMountTargetsPaginator

      default ListMountTargetsPublisher listMountTargetsPaginator(ListMountTargetsRequest listMountTargetsRequest)

      This is a variant of listMountTargets(software.amazon.awssdk.services.s3files.model.ListMountTargetsRequest) 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.s3files.paginators.ListMountTargetsPublisher publisher = client.listMountTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListMountTargetsPublisher publisher = client.listMountTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListMountTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListMountTargetsResponse 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 listMountTargets(software.amazon.awssdk.services.s3files.model.ListMountTargetsRequest) operation.

      Parameters:
      listMountTargetsRequest -
      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMountTargetsPaginator

      default ListMountTargetsPublisher listMountTargetsPaginator(Consumer<ListMountTargetsRequest.Builder> listMountTargetsRequest)

      This is a variant of listMountTargets(software.amazon.awssdk.services.s3files.model.ListMountTargetsRequest) 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.s3files.paginators.ListMountTargetsPublisher publisher = client.listMountTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListMountTargetsPublisher publisher = client.listMountTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListMountTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListMountTargetsResponse 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 listMountTargets(software.amazon.awssdk.services.s3files.model.ListMountTargetsRequest) operation.


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

      Parameters:
      listMountTargetsRequest - A Consumer that will call methods on ListMountTargetsRequest.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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Lists all tags for S3 Files resources.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Lists all tags for S3 Files resources.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.s3files.model.ListTagsForResourceRequest) 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.s3files.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.s3files.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.s3files.model.ListTagsForResourceRequest) 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.s3files.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3files.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3files.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3files.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.s3files.model.ListTagsForResourceRequest) operation.


      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 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFileSystemPolicy

      default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)

      Creates or replaces the IAM resource policy for an S3 File System to control access permissions.

      Parameters:
      putFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the PutFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFileSystemPolicy

      default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)

      Creates or replaces the IAM resource policy for an S3 File System to control access permissions.


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

      Parameters:
      putFileSystemPolicyRequest - A Consumer that will call methods on PutFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutFileSystemPolicy 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putSynchronizationConfiguration

      default CompletableFuture<PutSynchronizationConfigurationResponse> putSynchronizationConfiguration(PutSynchronizationConfigurationRequest putSynchronizationConfigurationRequest)

      Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

      Parameters:
      putSynchronizationConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutSynchronizationConfiguration 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putSynchronizationConfiguration

      default CompletableFuture<PutSynchronizationConfigurationResponse> putSynchronizationConfiguration(Consumer<PutSynchronizationConfigurationRequest.Builder> putSynchronizationConfigurationRequest)

      Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.


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

      Parameters:
      putSynchronizationConfigurationRequest - A Consumer that will call methods on PutSynchronizationConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutSynchronizationConfiguration 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • ConflictException The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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 tags for S3 Files resources using standard Amazon Web Services tagging APIs.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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 tags for S3 Files resources using standard Amazon Web Services tagging APIs.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Removes tags from S3 Files resources.

      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException 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)

      Removes tags from S3 Files resources.


      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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMountTarget

      default CompletableFuture<UpdateMountTargetResponse> updateMountTarget(UpdateMountTargetRequest updateMountTargetRequest)

      Updates the mount target resource, specifically security group configurations.

      Parameters:
      updateMountTargetRequest -
      Returns:
      A Java Future containing the result of the UpdateMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMountTarget

      default CompletableFuture<UpdateMountTargetResponse> updateMountTarget(Consumer<UpdateMountTargetRequest.Builder> updateMountTargetRequest)

      Updates the mount target resource, specifically security group configurations.


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

      Parameters:
      updateMountTargetRequest - A Consumer that will call methods on UpdateMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMountTarget 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.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource was not found. Verify that the resource exists and that you have permission to access it.
      • ThrottlingException The request was throttled. Retry your request using exponential backoff.
      • ValidationException The input parameters are not valid. Check the parameter values and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3FilesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default S3FilesServiceClientConfiguration 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 S3FilesAsyncClient create()
      Create a S3FilesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static S3FilesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a S3FilesAsyncClient.