Package software.amazon.awssdk.services.storagegateway

Interface StorageGatewayAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface StorageGatewayAsyncClient extends AwsClient
Service client for accessing AWS Storage Gateway 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. Storage Gateway Service

Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the Storage Gateway Service API Reference:

  • Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway.

  • Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.

  • Error responses: Provides reference information about Storage Gateway errors.

  • Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.

  • Storage Gateway endpoints and quotas: Provides a list of each Amazon Web Services Region and the endpoints available for use with Storage Gateway.

Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs.

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016.

  • Field Details

  • Method Details

    • activateGateway

      default CompletableFuture<ActivateGatewayResponse> activateGateway(ActivateGatewayRequest activateGatewayRequest)

      Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.

      You must turn on the gateway VM before you can activate your gateway.

      Parameters:
      activateGatewayRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the ActivateGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateGateway

      default CompletableFuture<ActivateGatewayResponse> activateGateway(Consumer<ActivateGatewayRequest.Builder> activateGatewayRequest)

      Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.

      You must turn on the gateway VM before you can activate your gateway.


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

      Parameters:
      activateGatewayRequest - A Consumer that will call methods on ActivateGatewayRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the ActivateGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addCache

      default CompletableFuture<AddCacheResponse> addCache(AddCacheRequest addCacheRequest)

      Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

      Parameters:
      addCacheRequest -
      Returns:
      A Java Future containing the result of the AddCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addCache

      default CompletableFuture<AddCacheResponse> addCache(Consumer<AddCacheRequest.Builder> addCacheRequest)

      Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.


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

      Parameters:
      addCacheRequest - A Consumer that will call methods on AddCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

      Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:

      • Storage gateways of all types

      • Storage volumes

      • Virtual tapes

      • NFS and SMB file shares

      • File System associations

      You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

      Parameters:
      addTagsToResourceRequest - AddTagsToResourceInput
      Returns:
      A Java Future containing the result of the AddTagsToResource 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)

      Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:

      • Storage gateways of all types

      • Storage volumes

      • Virtual tapes

      • NFS and SMB file shares

      • File System associations

      You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.


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

      Parameters:
      addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request. AddTagsToResourceInput
      Returns:
      A Java Future containing the result of the AddTagsToResource 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addUploadBuffer

      default CompletableFuture<AddUploadBufferResponse> addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)

      Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

      Parameters:
      addUploadBufferRequest -
      Returns:
      A Java Future containing the result of the AddUploadBuffer 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addUploadBuffer

      default CompletableFuture<AddUploadBufferResponse> addUploadBuffer(Consumer<AddUploadBufferRequest.Builder> addUploadBufferRequest)

      Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.


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

      Parameters:
      addUploadBufferRequest - A Consumer that will call methods on AddUploadBufferRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddUploadBuffer 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addWorkingStorage

      default CompletableFuture<AddWorkingStorageResponse> addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)

      Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

      Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

      Parameters:
      addWorkingStorageRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the AddWorkingStorage 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addWorkingStorage

      default CompletableFuture<AddWorkingStorageResponse> addWorkingStorage(Consumer<AddWorkingStorageRequest.Builder> addWorkingStorageRequest)

      Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

      Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

      In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.


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

      Parameters:
      addWorkingStorageRequest - A Consumer that will call methods on AddWorkingStorageRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the AddWorkingStorage 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • assignTapePool

      default CompletableFuture<AssignTapePoolResponse> assignTapePool(AssignTapePoolRequest assignTapePoolRequest)

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Parameters:
      assignTapePoolRequest -
      Returns:
      A Java Future containing the result of the AssignTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • assignTapePool

      default CompletableFuture<AssignTapePoolResponse> assignTapePool(Consumer<AssignTapePoolRequest.Builder> assignTapePoolRequest)

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.


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

      Parameters:
      assignTapePoolRequest - A Consumer that will call methods on AssignTapePoolRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssignTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateFileSystem

      default CompletableFuture<AssociateFileSystemResponse> associateFileSystem(AssociateFileSystemRequest associateFileSystemRequest)

      Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

      Parameters:
      associateFileSystemRequest -
      Returns:
      A Java Future containing the result of the AssociateFileSystem 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateFileSystem

      default CompletableFuture<AssociateFileSystemResponse> associateFileSystem(Consumer<AssociateFileSystemRequest.Builder> associateFileSystemRequest)

      Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.


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

      Parameters:
      associateFileSystemRequest - A Consumer that will call methods on AssociateFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateFileSystem 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachVolume

      default CompletableFuture<AttachVolumeResponse> attachVolume(AttachVolumeRequest attachVolumeRequest)

      Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

      Parameters:
      attachVolumeRequest - AttachVolumeInput
      Returns:
      A Java Future containing the result of the AttachVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachVolume

      default CompletableFuture<AttachVolumeResponse> attachVolume(Consumer<AttachVolumeRequest.Builder> attachVolumeRequest)

      Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.


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

      Parameters:
      attachVolumeRequest - A Consumer that will call methods on AttachVolumeRequest.Builder to create a request. AttachVolumeInput
      Returns:
      A Java Future containing the result of the AttachVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelArchival

      default CompletableFuture<CancelArchivalResponse> cancelArchival(CancelArchivalRequest cancelArchivalRequest)

      Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

      Parameters:
      cancelArchivalRequest - CancelArchivalInput
      Returns:
      A Java Future containing the result of the CancelArchival 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelArchival

      default CompletableFuture<CancelArchivalResponse> cancelArchival(Consumer<CancelArchivalRequest.Builder> cancelArchivalRequest)

      Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.


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

      Parameters:
      cancelArchivalRequest - A Consumer that will call methods on CancelArchivalRequest.Builder to create a request. CancelArchivalInput
      Returns:
      A Java Future containing the result of the CancelArchival 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelRetrieval

      default CompletableFuture<CancelRetrievalResponse> cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)

      Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

      Parameters:
      cancelRetrievalRequest - CancelRetrievalInput
      Returns:
      A Java Future containing the result of the CancelRetrieval 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelRetrieval

      default CompletableFuture<CancelRetrievalResponse> cancelRetrieval(Consumer<CancelRetrievalRequest.Builder> cancelRetrievalRequest)

      Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.


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

      Parameters:
      cancelRetrievalRequest - A Consumer that will call methods on CancelRetrievalRequest.Builder to create a request. CancelRetrievalInput
      Returns:
      A Java Future containing the result of the CancelRetrieval 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCachediSCSIVolume

      default CompletableFuture<CreateCachediScsiVolumeResponse> createCachediSCSIVolume(CreateCachediScsiVolumeRequest createCachediScsiVolumeRequest)

      Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

      Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

      In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

      Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

      Parameters:
      createCachediScsiVolumeRequest -
      Returns:
      A Java Future containing the result of the CreateCachediSCSIVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCachediSCSIVolume

      default CompletableFuture<CreateCachediScsiVolumeResponse> createCachediSCSIVolume(Consumer<CreateCachediScsiVolumeRequest.Builder> createCachediScsiVolumeRequest)

      Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

      Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

      In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

      Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.


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

      Parameters:
      createCachediScsiVolumeRequest - A Consumer that will call methods on CreateCachediScsiVolumeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCachediSCSIVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNFSFileShare

      default CompletableFuture<CreateNfsFileShareResponse> createNFSFileShare(CreateNfsFileShareRequest createNfsFileShareRequest)

      Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.

      S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      S3 File Gateways do not support creating hard or symbolic links on a file share.

      Parameters:
      createNfsFileShareRequest - CreateNFSFileShareInput
      Returns:
      A Java Future containing the result of the CreateNFSFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNFSFileShare

      default CompletableFuture<CreateNfsFileShareResponse> createNFSFileShare(Consumer<CreateNfsFileShareRequest.Builder> createNfsFileShareRequest)

      Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.

      S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      S3 File Gateways do not support creating hard or symbolic links on a file share.


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

      Parameters:
      createNfsFileShareRequest - A Consumer that will call methods on CreateNfsFileShareRequest.Builder to create a request. CreateNFSFileShareInput
      Returns:
      A Java Future containing the result of the CreateNFSFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSMBFileShare

      default CompletableFuture<CreateSmbFileShareResponse> createSMBFileShare(CreateSmbFileShareRequest createSmbFileShareRequest)

      Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.

      S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.

      Parameters:
      createSmbFileShareRequest - CreateSMBFileShareInput
      Returns:
      A Java Future containing the result of the CreateSMBFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSMBFileShare

      default CompletableFuture<CreateSmbFileShareResponse> createSMBFileShare(Consumer<CreateSmbFileShareRequest.Builder> createSmbFileShareRequest)

      Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.

      S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.


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

      Parameters:
      createSmbFileShareRequest - A Consumer that will call methods on CreateSmbFileShareRequest.Builder to create a request. CreateSMBFileShareInput
      Returns:
      A Java Future containing the result of the CreateSMBFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

      Initiates a snapshot of a volume.

      Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule.

      In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

      Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

      Parameters:
      createSnapshotRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the CreateSnapshot 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • ServiceUnavailableErrorException An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)

      Initiates a snapshot of a volume.

      Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule.

      In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

      Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.


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

      Parameters:
      createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the CreateSnapshot 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • ServiceUnavailableErrorException An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshotFromVolumeRecoveryPoint

      default CompletableFuture<CreateSnapshotFromVolumeRecoveryPointResponse> createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)

      Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

      A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

      In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

      Parameters:
      createSnapshotFromVolumeRecoveryPointRequest -
      Returns:
      A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • ServiceUnavailableErrorException An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshotFromVolumeRecoveryPoint

      default CompletableFuture<CreateSnapshotFromVolumeRecoveryPointResponse> createSnapshotFromVolumeRecoveryPoint(Consumer<CreateSnapshotFromVolumeRecoveryPointRequest.Builder> createSnapshotFromVolumeRecoveryPointRequest)

      Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

      A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

      In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.


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

      Parameters:
      createSnapshotFromVolumeRecoveryPointRequest - A Consumer that will call methods on CreateSnapshotFromVolumeRecoveryPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • ServiceUnavailableErrorException An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorediSCSIVolume

      default CompletableFuture<CreateStorediScsiVolumeResponse> createStorediSCSIVolume(CreateStorediScsiVolumeRequest createStorediScsiVolumeRequest)

      Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

      The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

      In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

      Parameters:
      createStorediScsiVolumeRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the CreateStorediSCSIVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorediSCSIVolume

      default CompletableFuture<CreateStorediScsiVolumeResponse> createStorediSCSIVolume(Consumer<CreateStorediScsiVolumeRequest.Builder> createStorediScsiVolumeRequest)

      Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

      The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

      In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.


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

      Parameters:
      createStorediScsiVolumeRequest - A Consumer that will call methods on CreateStorediScsiVolumeRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the CreateStorediSCSIVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapePool

      default CompletableFuture<CreateTapePoolResponse> createTapePool(CreateTapePoolRequest createTapePoolRequest)

      Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

      Parameters:
      createTapePoolRequest -
      Returns:
      A Java Future containing the result of the CreateTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapePool

      default CompletableFuture<CreateTapePoolResponse> createTapePool(Consumer<CreateTapePoolRequest.Builder> createTapePoolRequest)

      Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.


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

      Parameters:
      createTapePoolRequest - A Consumer that will call methods on CreateTapePoolRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapeWithBarcode

      default CompletableFuture<CreateTapeWithBarcodeResponse> createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)

      Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

      Parameters:
      createTapeWithBarcodeRequest - CreateTapeWithBarcodeInput
      Returns:
      A Java Future containing the result of the CreateTapeWithBarcode 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapeWithBarcode

      default CompletableFuture<CreateTapeWithBarcodeResponse> createTapeWithBarcode(Consumer<CreateTapeWithBarcodeRequest.Builder> createTapeWithBarcodeRequest)

      Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.


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

      Parameters:
      createTapeWithBarcodeRequest - A Consumer that will call methods on CreateTapeWithBarcodeRequest.Builder to create a request. CreateTapeWithBarcodeInput
      Returns:
      A Java Future containing the result of the CreateTapeWithBarcode 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapes

      default CompletableFuture<CreateTapesResponse> createTapes(CreateTapesRequest createTapesRequest)

      Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

      Parameters:
      createTapesRequest - CreateTapesInput
      Returns:
      A Java Future containing the result of the CreateTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTapes

      default CompletableFuture<CreateTapesResponse> createTapes(Consumer<CreateTapesRequest.Builder> createTapesRequest)

      Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.


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

      Parameters:
      createTapesRequest - A Consumer that will call methods on CreateTapesRequest.Builder to create a request. CreateTapesInput
      Returns:
      A Java Future containing the result of the CreateTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAutomaticTapeCreationPolicy

      default CompletableFuture<DeleteAutomaticTapeCreationPolicyResponse> deleteAutomaticTapeCreationPolicy(DeleteAutomaticTapeCreationPolicyRequest deleteAutomaticTapeCreationPolicyRequest)

      Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

      Parameters:
      deleteAutomaticTapeCreationPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteAutomaticTapeCreationPolicy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAutomaticTapeCreationPolicy

      default CompletableFuture<DeleteAutomaticTapeCreationPolicyResponse> deleteAutomaticTapeCreationPolicy(Consumer<DeleteAutomaticTapeCreationPolicyRequest.Builder> deleteAutomaticTapeCreationPolicyRequest)

      Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.


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

      Parameters:
      deleteAutomaticTapeCreationPolicyRequest - A Consumer that will call methods on DeleteAutomaticTapeCreationPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAutomaticTapeCreationPolicy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBandwidthRateLimit

      default CompletableFuture<DeleteBandwidthRateLimitResponse> deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)

      Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.

      Parameters:
      deleteBandwidthRateLimitRequest - A JSON object containing the following fields:

      Returns:
      A Java Future containing the result of the DeleteBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBandwidthRateLimit

      default CompletableFuture<DeleteBandwidthRateLimitResponse> deleteBandwidthRateLimit(Consumer<DeleteBandwidthRateLimitRequest.Builder> deleteBandwidthRateLimitRequest)

      Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.


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

      Parameters:
      deleteBandwidthRateLimitRequest - A Consumer that will call methods on DeleteBandwidthRateLimitRequest.Builder to create a request. A JSON object containing the following fields:

      Returns:
      A Java Future containing the result of the DeleteBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChapCredentials

      default CompletableFuture<DeleteChapCredentialsResponse> deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)

      Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.

      Parameters:
      deleteChapCredentialsRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the DeleteChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChapCredentials

      default CompletableFuture<DeleteChapCredentialsResponse> deleteChapCredentials(Consumer<DeleteChapCredentialsRequest.Builder> deleteChapCredentialsRequest)

      Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.


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

      Parameters:
      deleteChapCredentialsRequest - A Consumer that will call methods on DeleteChapCredentialsRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the DeleteChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileShare

      default CompletableFuture<DeleteFileShareResponse> deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)

      Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.

      Parameters:
      deleteFileShareRequest - DeleteFileShareInput
      Returns:
      A Java Future containing the result of the DeleteFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileShare

      default CompletableFuture<DeleteFileShareResponse> deleteFileShare(Consumer<DeleteFileShareRequest.Builder> deleteFileShareRequest)

      Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.


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

      Parameters:
      deleteFileShareRequest - A Consumer that will call methods on DeleteFileShareRequest.Builder to create a request. DeleteFileShareInput
      Returns:
      A Java Future containing the result of the DeleteFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(DeleteGatewayRequest deleteGatewayRequest)

      Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

      After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

      You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page.

      Parameters:
      deleteGatewayRequest - A JSON object containing the ID of the gateway to delete.
      Returns:
      A Java Future containing the result of the DeleteGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGateway

      default CompletableFuture<DeleteGatewayResponse> deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)

      Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

      After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

      You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page.


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

      Parameters:
      deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayRequest.Builder to create a request. A JSON object containing the ID of the gateway to delete.
      Returns:
      A Java Future containing the result of the DeleteGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSnapshotSchedule

      default CompletableFuture<DeleteSnapshotScheduleResponse> deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)

      Deletes a snapshot of a volume.

      You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

      Parameters:
      deleteSnapshotScheduleRequest -
      Returns:
      A Java Future containing the result of the DeleteSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSnapshotSchedule

      default CompletableFuture<DeleteSnapshotScheduleResponse> deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest)

      Deletes a snapshot of a volume.

      You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.


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

      Parameters:
      deleteSnapshotScheduleRequest - A Consumer that will call methods on DeleteSnapshotScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTape

      default CompletableFuture<DeleteTapeResponse> deleteTape(DeleteTapeRequest deleteTapeRequest)

      Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

      Parameters:
      deleteTapeRequest - DeleteTapeInput
      Returns:
      A Java Future containing the result of the DeleteTape 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTape

      default CompletableFuture<DeleteTapeResponse> deleteTape(Consumer<DeleteTapeRequest.Builder> deleteTapeRequest)

      Deletes the specified virtual tape. This operation is only supported in the tape gateway type.


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

      Parameters:
      deleteTapeRequest - A Consumer that will call methods on DeleteTapeRequest.Builder to create a request. DeleteTapeInput
      Returns:
      A Java Future containing the result of the DeleteTape 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTapeArchive

      default CompletableFuture<DeleteTapeArchiveResponse> deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)

      Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

      Parameters:
      deleteTapeArchiveRequest - DeleteTapeArchiveInput
      Returns:
      A Java Future containing the result of the DeleteTapeArchive 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTapeArchive

      default CompletableFuture<DeleteTapeArchiveResponse> deleteTapeArchive(Consumer<DeleteTapeArchiveRequest.Builder> deleteTapeArchiveRequest)

      Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.


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

      Parameters:
      deleteTapeArchiveRequest - A Consumer that will call methods on DeleteTapeArchiveRequest.Builder to create a request. DeleteTapeArchiveInput
      Returns:
      A Java Future containing the result of the DeleteTapeArchive 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTapePool

      default CompletableFuture<DeleteTapePoolResponse> deleteTapePool(DeleteTapePoolRequest deleteTapePoolRequest)

      Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

      Parameters:
      deleteTapePoolRequest -
      Returns:
      A Java Future containing the result of the DeleteTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTapePool

      default CompletableFuture<DeleteTapePoolResponse> deleteTapePool(Consumer<DeleteTapePoolRequest.Builder> deleteTapePoolRequest)

      Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.


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

      Parameters:
      deleteTapePoolRequest - A Consumer that will call methods on DeleteTapePoolRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTapePool 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(DeleteVolumeRequest deleteVolumeRequest)

      Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

      Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

      In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

      Parameters:
      deleteVolumeRequest - A JSON object containing the DeleteVolumeInputinvalid input: '&#36'VolumeARN to delete.
      Returns:
      A Java Future containing the result of the DeleteVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)

      Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

      Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

      In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.


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

      Parameters:
      deleteVolumeRequest - A Consumer that will call methods on DeleteVolumeRequest.Builder to create a request. A JSON object containing the DeleteVolumeInputinvalid input: '&#36'VolumeARN to delete.
      Returns:
      A Java Future containing the result of the DeleteVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailabilityMonitorTest

      default CompletableFuture<DescribeAvailabilityMonitorTestResponse> describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest)

      Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

      Parameters:
      describeAvailabilityMonitorTestRequest -
      Returns:
      A Java Future containing the result of the DescribeAvailabilityMonitorTest 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAvailabilityMonitorTest

      default CompletableFuture<DescribeAvailabilityMonitorTestResponse> describeAvailabilityMonitorTest(Consumer<DescribeAvailabilityMonitorTestRequest.Builder> describeAvailabilityMonitorTestRequest)

      Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.


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

      Parameters:
      describeAvailabilityMonitorTestRequest - A Consumer that will call methods on DescribeAvailabilityMonitorTestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAvailabilityMonitorTest 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBandwidthRateLimit

      default CompletableFuture<DescribeBandwidthRateLimitResponse> describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)

      Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

      This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      describeBandwidthRateLimitRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBandwidthRateLimit

      default CompletableFuture<DescribeBandwidthRateLimitResponse> describeBandwidthRateLimit(Consumer<DescribeBandwidthRateLimitRequest.Builder> describeBandwidthRateLimitRequest)

      Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

      This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      describeBandwidthRateLimitRequest - A Consumer that will call methods on DescribeBandwidthRateLimitRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBandwidthRateLimitSchedule

      default CompletableFuture<DescribeBandwidthRateLimitScheduleResponse> describeBandwidthRateLimitSchedule(DescribeBandwidthRateLimitScheduleRequest describeBandwidthRateLimitScheduleRequest)

      Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

      This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

      A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

      If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      describeBandwidthRateLimitScheduleRequest -
      Returns:
      A Java Future containing the result of the DescribeBandwidthRateLimitSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBandwidthRateLimitSchedule

      default CompletableFuture<DescribeBandwidthRateLimitScheduleResponse> describeBandwidthRateLimitSchedule(Consumer<DescribeBandwidthRateLimitScheduleRequest.Builder> describeBandwidthRateLimitScheduleRequest)

      Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

      This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

      A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

      If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      describeBandwidthRateLimitScheduleRequest - A Consumer that will call methods on DescribeBandwidthRateLimitScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBandwidthRateLimitSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCache

      default CompletableFuture<DescribeCacheResponse> describeCache(DescribeCacheRequest describeCacheRequest)

      Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

      The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

      Parameters:
      describeCacheRequest -
      Returns:
      A Java Future containing the result of the DescribeCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCache

      default CompletableFuture<DescribeCacheResponse> describeCache(Consumer<DescribeCacheRequest.Builder> describeCacheRequest)

      Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

      The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.


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

      Parameters:
      describeCacheRequest - A Consumer that will call methods on DescribeCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCachediSCSIVolumes

      default CompletableFuture<DescribeCachediScsiVolumesResponse> describeCachediSCSIVolumes(DescribeCachediScsiVolumesRequest describeCachediScsiVolumesRequest)

      Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

      The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

      Parameters:
      describeCachediScsiVolumesRequest -
      Returns:
      A Java Future containing the result of the DescribeCachediSCSIVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCachediSCSIVolumes

      default CompletableFuture<DescribeCachediScsiVolumesResponse> describeCachediSCSIVolumes(Consumer<DescribeCachediScsiVolumesRequest.Builder> describeCachediScsiVolumesRequest)

      Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

      The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).


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

      Parameters:
      describeCachediScsiVolumesRequest - A Consumer that will call methods on DescribeCachediScsiVolumesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCachediSCSIVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeChapCredentials

      default CompletableFuture<DescribeChapCredentialsResponse> describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest)

      Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

      Parameters:
      describeChapCredentialsRequest - A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
      Returns:
      A Java Future containing the result of the DescribeChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeChapCredentials

      default CompletableFuture<DescribeChapCredentialsResponse> describeChapCredentials(Consumer<DescribeChapCredentialsRequest.Builder> describeChapCredentialsRequest)

      Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.


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

      Parameters:
      describeChapCredentialsRequest - A Consumer that will call methods on DescribeChapCredentialsRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
      Returns:
      A Java Future containing the result of the DescribeChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAssociations

      default CompletableFuture<DescribeFileSystemAssociationsResponse> describeFileSystemAssociations(DescribeFileSystemAssociationsRequest describeFileSystemAssociationsRequest)

      Gets the file system association information. This operation is only supported for FSx File Gateways.

      Parameters:
      describeFileSystemAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeFileSystemAssociations 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAssociations

      default CompletableFuture<DescribeFileSystemAssociationsResponse> describeFileSystemAssociations(Consumer<DescribeFileSystemAssociationsRequest.Builder> describeFileSystemAssociationsRequest)

      Gets the file system association information. This operation is only supported for FSx File Gateways.


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

      Parameters:
      describeFileSystemAssociationsRequest - A Consumer that will call methods on DescribeFileSystemAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFileSystemAssociations 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGatewayInformation

      default CompletableFuture<DescribeGatewayInformationResponse> describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)

      Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      describeGatewayInformationRequest - A JSON object containing the ID of the gateway.
      Returns:
      A Java Future containing the result of the DescribeGatewayInformation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGatewayInformation

      default CompletableFuture<DescribeGatewayInformationResponse> describeGatewayInformation(Consumer<DescribeGatewayInformationRequest.Builder> describeGatewayInformationRequest)

      Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      describeGatewayInformationRequest - A Consumer that will call methods on DescribeGatewayInformationRequest.Builder to create a request. A JSON object containing the ID of the gateway.
      Returns:
      A Java Future containing the result of the DescribeGatewayInformation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceStartTime

      default CompletableFuture<DescribeMaintenanceStartTimeResponse> describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)

      Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

      Parameters:
      describeMaintenanceStartTimeRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceStartTime 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMaintenanceStartTime

      default CompletableFuture<DescribeMaintenanceStartTimeResponse> describeMaintenanceStartTime(Consumer<DescribeMaintenanceStartTimeRequest.Builder> describeMaintenanceStartTimeRequest)

      Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.


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

      Parameters:
      describeMaintenanceStartTimeRequest - A Consumer that will call methods on DescribeMaintenanceStartTimeRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeMaintenanceStartTime 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNFSFileShares

      default CompletableFuture<DescribeNfsFileSharesResponse> describeNFSFileShares(DescribeNfsFileSharesRequest describeNfsFileSharesRequest)

      Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.

      Parameters:
      describeNfsFileSharesRequest - DescribeNFSFileSharesInput
      Returns:
      A Java Future containing the result of the DescribeNFSFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNFSFileShares

      default CompletableFuture<DescribeNfsFileSharesResponse> describeNFSFileShares(Consumer<DescribeNfsFileSharesRequest.Builder> describeNfsFileSharesRequest)

      Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.


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

      Parameters:
      describeNfsFileSharesRequest - A Consumer that will call methods on DescribeNfsFileSharesRequest.Builder to create a request. DescribeNFSFileSharesInput
      Returns:
      A Java Future containing the result of the DescribeNFSFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSMBFileShares

      default CompletableFuture<DescribeSmbFileSharesResponse> describeSMBFileShares(DescribeSmbFileSharesRequest describeSmbFileSharesRequest)

      Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.

      Parameters:
      describeSmbFileSharesRequest - DescribeSMBFileSharesInput
      Returns:
      A Java Future containing the result of the DescribeSMBFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSMBFileShares

      default CompletableFuture<DescribeSmbFileSharesResponse> describeSMBFileShares(Consumer<DescribeSmbFileSharesRequest.Builder> describeSmbFileSharesRequest)

      Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.


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

      Parameters:
      describeSmbFileSharesRequest - A Consumer that will call methods on DescribeSmbFileSharesRequest.Builder to create a request. DescribeSMBFileSharesInput
      Returns:
      A Java Future containing the result of the DescribeSMBFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSMBSettings

      default CompletableFuture<DescribeSmbSettingsResponse> describeSMBSettings(DescribeSmbSettingsRequest describeSmbSettingsRequest)

      Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

      Parameters:
      describeSmbSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeSMBSettings 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSMBSettings

      default CompletableFuture<DescribeSmbSettingsResponse> describeSMBSettings(Consumer<DescribeSmbSettingsRequest.Builder> describeSmbSettingsRequest)

      Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.


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

      Parameters:
      describeSmbSettingsRequest - A Consumer that will call methods on DescribeSmbSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSMBSettings 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshotSchedule

      default CompletableFuture<DescribeSnapshotScheduleResponse> describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)

      Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

      Parameters:
      describeSnapshotScheduleRequest - A JSON object containing the DescribeSnapshotScheduleInputinvalid input: '&#36'VolumeARN of the volume.
      Returns:
      A Java Future containing the result of the DescribeSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshotSchedule

      default CompletableFuture<DescribeSnapshotScheduleResponse> describeSnapshotSchedule(Consumer<DescribeSnapshotScheduleRequest.Builder> describeSnapshotScheduleRequest)

      Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.


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

      Parameters:
      describeSnapshotScheduleRequest - A Consumer that will call methods on DescribeSnapshotScheduleRequest.Builder to create a request. A JSON object containing the DescribeSnapshotScheduleInputinvalid input: '&#36'VolumeARN of the volume.
      Returns:
      A Java Future containing the result of the DescribeSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorediSCSIVolumes

      default CompletableFuture<DescribeStorediScsiVolumesResponse> describeStorediSCSIVolumes(DescribeStorediScsiVolumesRequest describeStorediScsiVolumesRequest)

      Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

      Parameters:
      describeStorediScsiVolumesRequest - A JSON object containing a list of DescribeStorediSCSIVolumesInputinvalid input: '&#36'VolumeARNs.
      Returns:
      A Java Future containing the result of the DescribeStorediSCSIVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorediSCSIVolumes

      default CompletableFuture<DescribeStorediScsiVolumesResponse> describeStorediSCSIVolumes(Consumer<DescribeStorediScsiVolumesRequest.Builder> describeStorediScsiVolumesRequest)

      Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.


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

      Parameters:
      describeStorediScsiVolumesRequest - A Consumer that will call methods on DescribeStorediScsiVolumesRequest.Builder to create a request. A JSON object containing a list of DescribeStorediSCSIVolumesInputinvalid input: '&#36'VolumeARNs.
      Returns:
      A Java Future containing the result of the DescribeStorediSCSIVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchives

      default CompletableFuture<DescribeTapeArchivesResponse> describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)

      Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

      If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

      Parameters:
      describeTapeArchivesRequest - DescribeTapeArchivesInput
      Returns:
      A Java Future containing the result of the DescribeTapeArchives 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchives

      default CompletableFuture<DescribeTapeArchivesResponse> describeTapeArchives(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest)

      Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

      If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.


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

      Parameters:
      describeTapeArchivesRequest - A Consumer that will call methods on DescribeTapeArchivesRequest.Builder to create a request. DescribeTapeArchivesInput
      Returns:
      A Java Future containing the result of the DescribeTapeArchives 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchives

      default CompletableFuture<DescribeTapeArchivesResponse> describeTapeArchives()

      Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

      If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

      Returns:
      A Java Future containing the result of the DescribeTapeArchives 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchivesPaginator

      default DescribeTapeArchivesPublisher describeTapeArchivesPaginator()

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

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchivesPaginator

      default DescribeTapeArchivesPublisher describeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest)

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

      Parameters:
      describeTapeArchivesRequest - DescribeTapeArchivesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeArchivesPaginator

      default DescribeTapeArchivesPublisher describeTapeArchivesPaginator(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest)

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


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

      Parameters:
      describeTapeArchivesRequest - A Consumer that will call methods on DescribeTapeArchivesRequest.Builder to create a request. DescribeTapeArchivesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeRecoveryPoints

      default CompletableFuture<DescribeTapeRecoveryPointsResponse> describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)

      Returns a list of virtual tape recovery points that are available for the specified tape gateway.

      A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

      Parameters:
      describeTapeRecoveryPointsRequest - DescribeTapeRecoveryPointsInput
      Returns:
      A Java Future containing the result of the DescribeTapeRecoveryPoints 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeRecoveryPoints

      default CompletableFuture<DescribeTapeRecoveryPointsResponse> describeTapeRecoveryPoints(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest)

      Returns a list of virtual tape recovery points that are available for the specified tape gateway.

      A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.


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

      Parameters:
      describeTapeRecoveryPointsRequest - A Consumer that will call methods on DescribeTapeRecoveryPointsRequest.Builder to create a request. DescribeTapeRecoveryPointsInput
      Returns:
      A Java Future containing the result of the DescribeTapeRecoveryPoints 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeRecoveryPointsPaginator

      default DescribeTapeRecoveryPointsPublisher describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)

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

      Parameters:
      describeTapeRecoveryPointsRequest - DescribeTapeRecoveryPointsInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapeRecoveryPointsPaginator

      default DescribeTapeRecoveryPointsPublisher describeTapeRecoveryPointsPaginator(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest)

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


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

      Parameters:
      describeTapeRecoveryPointsRequest - A Consumer that will call methods on DescribeTapeRecoveryPointsRequest.Builder to create a request. DescribeTapeRecoveryPointsInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapes

      default CompletableFuture<DescribeTapesResponse> describeTapes(DescribeTapesRequest describeTapesRequest)

      Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

      The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.

      Parameters:
      describeTapesRequest - DescribeTapesInput
      Returns:
      A Java Future containing the result of the DescribeTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapes

      default CompletableFuture<DescribeTapesResponse> describeTapes(Consumer<DescribeTapesRequest.Builder> describeTapesRequest)

      Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

      The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.


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

      Parameters:
      describeTapesRequest - A Consumer that will call methods on DescribeTapesRequest.Builder to create a request. DescribeTapesInput
      Returns:
      A Java Future containing the result of the DescribeTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapesPaginator

      default DescribeTapesPublisher describeTapesPaginator(DescribeTapesRequest describeTapesRequest)

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

      Parameters:
      describeTapesRequest - DescribeTapesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTapesPaginator

      default DescribeTapesPublisher describeTapesPaginator(Consumer<DescribeTapesRequest.Builder> describeTapesRequest)

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


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

      Parameters:
      describeTapesRequest - A Consumer that will call methods on DescribeTapesRequest.Builder to create a request. DescribeTapesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUploadBuffer

      default CompletableFuture<DescribeUploadBufferResponse> describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)

      Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

      The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

      Parameters:
      describeUploadBufferRequest -
      Returns:
      A Java Future containing the result of the DescribeUploadBuffer 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUploadBuffer

      default CompletableFuture<DescribeUploadBufferResponse> describeUploadBuffer(Consumer<DescribeUploadBufferRequest.Builder> describeUploadBufferRequest)

      Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

      The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.


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

      Parameters:
      describeUploadBufferRequest - A Consumer that will call methods on DescribeUploadBufferRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUploadBuffer 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVTLDevices

      default CompletableFuture<DescribeVtlDevicesResponse> describeVTLDevices(DescribeVtlDevicesRequest describeVtlDevicesRequest)

      Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.

      This operation is only supported in the tape gateway type.

      Parameters:
      describeVtlDevicesRequest - DescribeVTLDevicesInput
      Returns:
      A Java Future containing the result of the DescribeVTLDevices 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVTLDevices

      default CompletableFuture<DescribeVtlDevicesResponse> describeVTLDevices(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest)

      Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.

      This operation is only supported in the tape gateway type.


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

      Parameters:
      describeVtlDevicesRequest - A Consumer that will call methods on DescribeVtlDevicesRequest.Builder to create a request. DescribeVTLDevicesInput
      Returns:
      A Java Future containing the result of the DescribeVTLDevices 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVTLDevicesPaginator

      default DescribeVTLDevicesPublisher describeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest)

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

      Parameters:
      describeVtlDevicesRequest - DescribeVTLDevicesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVTLDevicesPaginator

      default DescribeVTLDevicesPublisher describeVTLDevicesPaginator(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest)

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


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

      Parameters:
      describeVtlDevicesRequest - A Consumer that will call methods on DescribeVtlDevicesRequest.Builder to create a request. DescribeVTLDevicesInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkingStorage

      default CompletableFuture<DescribeWorkingStorageResponse> describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)

      Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

      Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

      The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

      Parameters:
      describeWorkingStorageRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeWorkingStorage 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkingStorage

      default CompletableFuture<DescribeWorkingStorageResponse> describeWorkingStorage(Consumer<DescribeWorkingStorageRequest.Builder> describeWorkingStorageRequest)

      Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

      Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

      The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.


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

      Parameters:
      describeWorkingStorageRequest - A Consumer that will call methods on DescribeWorkingStorageRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the DescribeWorkingStorage 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachVolume

      default CompletableFuture<DetachVolumeResponse> detachVolume(DetachVolumeRequest detachVolumeRequest)

      Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.

      Parameters:
      detachVolumeRequest - AttachVolumeInput
      Returns:
      A Java Future containing the result of the DetachVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachVolume

      default CompletableFuture<DetachVolumeResponse> detachVolume(Consumer<DetachVolumeRequest.Builder> detachVolumeRequest)

      Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.


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

      Parameters:
      detachVolumeRequest - A Consumer that will call methods on DetachVolumeRequest.Builder to create a request. AttachVolumeInput
      Returns:
      A Java Future containing the result of the DetachVolume 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableGateway

      default CompletableFuture<DisableGatewayResponse> disableGateway(DisableGatewayRequest disableGatewayRequest)

      Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

      Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

      After a gateway is disabled, it cannot be enabled.

      Parameters:
      disableGatewayRequest - DisableGatewayInput
      Returns:
      A Java Future containing the result of the DisableGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableGateway

      default CompletableFuture<DisableGatewayResponse> disableGateway(Consumer<DisableGatewayRequest.Builder> disableGatewayRequest)

      Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

      Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

      After a gateway is disabled, it cannot be enabled.


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

      Parameters:
      disableGatewayRequest - A Consumer that will call methods on DisableGatewayRequest.Builder to create a request. DisableGatewayInput
      Returns:
      A Java Future containing the result of the DisableGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFileSystem

      default CompletableFuture<DisassociateFileSystemResponse> disassociateFileSystem(DisassociateFileSystemRequest disassociateFileSystemRequest)

      Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

      Parameters:
      disassociateFileSystemRequest -
      Returns:
      A Java Future containing the result of the DisassociateFileSystem 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFileSystem

      default CompletableFuture<DisassociateFileSystemResponse> disassociateFileSystem(Consumer<DisassociateFileSystemRequest.Builder> disassociateFileSystemRequest)

      Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.


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

      Parameters:
      disassociateFileSystemRequest - A Consumer that will call methods on DisassociateFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateFileSystem 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • joinDomain

      default CompletableFuture<JoinDomainResponse> joinDomain(JoinDomainRequest joinDomainRequest)

      Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

      Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.

      To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.

      Parameters:
      joinDomainRequest - JoinDomainInput
      Returns:
      A Java Future containing the result of the JoinDomain 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • joinDomain

      default CompletableFuture<JoinDomainResponse> joinDomain(Consumer<JoinDomainRequest.Builder> joinDomainRequest)

      Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

      Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.

      To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.


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

      Parameters:
      joinDomainRequest - A Consumer that will call methods on JoinDomainRequest.Builder to create a request. JoinDomainInput
      Returns:
      A Java Future containing the result of the JoinDomain 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutomaticTapeCreationPolicies

      default CompletableFuture<ListAutomaticTapeCreationPoliciesResponse> listAutomaticTapeCreationPolicies(ListAutomaticTapeCreationPoliciesRequest listAutomaticTapeCreationPoliciesRequest)

      Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

      This operation is only supported for tape gateways.

      Parameters:
      listAutomaticTapeCreationPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListAutomaticTapeCreationPolicies 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutomaticTapeCreationPolicies

      default CompletableFuture<ListAutomaticTapeCreationPoliciesResponse> listAutomaticTapeCreationPolicies(Consumer<ListAutomaticTapeCreationPoliciesRequest.Builder> listAutomaticTapeCreationPoliciesRequest)

      Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

      This operation is only supported for tape gateways.


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

      Parameters:
      listAutomaticTapeCreationPoliciesRequest - A Consumer that will call methods on ListAutomaticTapeCreationPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAutomaticTapeCreationPolicies 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileShares

      default CompletableFuture<ListFileSharesResponse> listFileShares(ListFileSharesRequest listFileSharesRequest)

      Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.

      Parameters:
      listFileSharesRequest - ListFileShareInput
      Returns:
      A Java Future containing the result of the ListFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileShares

      default CompletableFuture<ListFileSharesResponse> listFileShares(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest)

      Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.


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

      Parameters:
      listFileSharesRequest - A Consumer that will call methods on ListFileSharesRequest.Builder to create a request. ListFileShareInput
      Returns:
      A Java Future containing the result of the ListFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileShares

      default CompletableFuture<ListFileSharesResponse> listFileShares()

      Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.

      Returns:
      A Java Future containing the result of the ListFileShares 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSharesPaginator

      default ListFileSharesPublisher listFileSharesPaginator()

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

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSharesPaginator

      default ListFileSharesPublisher listFileSharesPaginator(ListFileSharesRequest listFileSharesRequest)

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

      Parameters:
      listFileSharesRequest - ListFileShareInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSharesPaginator

      default ListFileSharesPublisher listFileSharesPaginator(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest)

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


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

      Parameters:
      listFileSharesRequest - A Consumer that will call methods on ListFileSharesRequest.Builder to create a request. ListFileShareInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemAssociations

      default CompletableFuture<ListFileSystemAssociationsResponse> listFileSystemAssociations(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest)

      Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

      Parameters:
      listFileSystemAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListFileSystemAssociations 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemAssociations

      default CompletableFuture<ListFileSystemAssociationsResponse> listFileSystemAssociations(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest)

      Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.


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

      Parameters:
      listFileSystemAssociationsRequest - A Consumer that will call methods on ListFileSystemAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFileSystemAssociations 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemAssociationsPaginator

      default ListFileSystemAssociationsPublisher listFileSystemAssociationsPaginator(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest)

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

      Parameters:
      listFileSystemAssociationsRequest -
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFileSystemAssociationsPaginator

      default ListFileSystemAssociationsPublisher listFileSystemAssociationsPaginator(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest)

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


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

      Parameters:
      listFileSystemAssociationsRequest - A Consumer that will call methods on ListFileSystemAssociationsRequest.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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(ListGatewaysRequest listGatewaysRequest)

      Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

      By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

      If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

      Parameters:
      listGatewaysRequest - A JSON object containing zero or more of the following fields:

      Returns:
      A Java Future containing the result of the ListGateways 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)

      Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

      By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

      If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request. A JSON object containing zero or more of the following fields:

      Returns:
      A Java Future containing the result of the ListGateways 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGateways

      default CompletableFuture<ListGatewaysResponse> listGateways()

      Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

      By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

      If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

      Returns:
      A Java Future containing the result of the ListGateways 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator()

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

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)

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

      Parameters:
      listGatewaysRequest - A JSON object containing zero or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGatewaysPaginator

      default ListGatewaysPublisher listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)

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


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

      Parameters:
      listGatewaysRequest - A Consumer that will call methods on ListGatewaysRequest.Builder to create a request. A JSON object containing zero or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocalDisks

      default CompletableFuture<ListLocalDisksResponse> listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)

      Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

      The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

      Parameters:
      listLocalDisksRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the ListLocalDisks 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocalDisks

      default CompletableFuture<ListLocalDisksResponse> listLocalDisks(Consumer<ListLocalDisksRequest.Builder> listLocalDisksRequest)

      Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

      The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).


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

      Parameters:
      listLocalDisksRequest - A Consumer that will call methods on ListLocalDisksRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.
      Returns:
      A Java Future containing the result of the ListLocalDisks 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException 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 the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.

      Parameters:
      listTagsForResourceRequest - ListTagsForResourceInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException 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 the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.


      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. ListTagsForResourceInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException 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.storagegateway.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.storagegateway.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.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.storagegateway.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 Limit 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.storagegateway.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest - ListTagsForResourceInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException 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.storagegateway.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.storagegateway.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.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.storagegateway.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 Limit 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.storagegateway.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. ListTagsForResourceInput
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapePools

      default CompletableFuture<ListTapePoolsResponse> listTapePools(ListTapePoolsRequest listTapePoolsRequest)

      Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

      This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

      Parameters:
      listTapePoolsRequest -
      Returns:
      A Java Future containing the result of the ListTapePools 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapePools

      default CompletableFuture<ListTapePoolsResponse> listTapePools(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest)

      Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

      This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.


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

      Parameters:
      listTapePoolsRequest - A Consumer that will call methods on ListTapePoolsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTapePools 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapePoolsPaginator

      default ListTapePoolsPublisher listTapePoolsPaginator(ListTapePoolsRequest listTapePoolsRequest)

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

      Parameters:
      listTapePoolsRequest -
      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapePoolsPaginator

      default ListTapePoolsPublisher listTapePoolsPaginator(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest)

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


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

      Parameters:
      listTapePoolsRequest - A Consumer that will call methods on ListTapePoolsRequest.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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapes

      default CompletableFuture<ListTapesResponse> listTapes(ListTapesRequest listTapesRequest)

      Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

      This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

      Parameters:
      listTapesRequest - A JSON object that contains one or more of the following fields:

      Returns:
      A Java Future containing the result of the ListTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapes

      default CompletableFuture<ListTapesResponse> listTapes(Consumer<ListTapesRequest.Builder> listTapesRequest)

      Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

      This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.


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

      Parameters:
      listTapesRequest - A Consumer that will call methods on ListTapesRequest.Builder to create a request. A JSON object that contains one or more of the following fields:

      Returns:
      A Java Future containing the result of the ListTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapes

      default CompletableFuture<ListTapesResponse> listTapes()

      Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

      This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

      Returns:
      A Java Future containing the result of the ListTapes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapesPaginator

      default ListTapesPublisher listTapesPaginator()

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

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapesPaginator

      default ListTapesPublisher listTapesPaginator(ListTapesRequest listTapesRequest)

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

      Parameters:
      listTapesRequest - A JSON object that contains one or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTapesPaginator

      default ListTapesPublisher listTapesPaginator(Consumer<ListTapesRequest.Builder> listTapesRequest)

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


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

      Parameters:
      listTapesRequest - A Consumer that will call methods on ListTapesRequest.Builder to create a request. A JSON object that contains one or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumeInitiators

      default CompletableFuture<ListVolumeInitiatorsResponse> listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)

      Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

      Parameters:
      listVolumeInitiatorsRequest - ListVolumeInitiatorsInput
      Returns:
      A Java Future containing the result of the ListVolumeInitiators 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumeInitiators

      default CompletableFuture<ListVolumeInitiatorsResponse> listVolumeInitiators(Consumer<ListVolumeInitiatorsRequest.Builder> listVolumeInitiatorsRequest)

      Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.


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

      Parameters:
      listVolumeInitiatorsRequest - A Consumer that will call methods on ListVolumeInitiatorsRequest.Builder to create a request. ListVolumeInitiatorsInput
      Returns:
      A Java Future containing the result of the ListVolumeInitiators 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumeRecoveryPoints

      default CompletableFuture<ListVolumeRecoveryPointsResponse> listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)

      Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

      Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

      Parameters:
      listVolumeRecoveryPointsRequest -
      Returns:
      A Java Future containing the result of the ListVolumeRecoveryPoints 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumeRecoveryPoints

      default CompletableFuture<ListVolumeRecoveryPointsResponse> listVolumeRecoveryPoints(Consumer<ListVolumeRecoveryPointsRequest.Builder> listVolumeRecoveryPointsRequest)

      Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

      Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.


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

      Parameters:
      listVolumeRecoveryPointsRequest - A Consumer that will call methods on ListVolumeRecoveryPointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVolumeRecoveryPoints 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumes

      default CompletableFuture<ListVolumesResponse> listVolumes(ListVolumesRequest listVolumesRequest)

      Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

      The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

      Parameters:
      listVolumesRequest - A JSON object that contains one or more of the following fields:

      Returns:
      A Java Future containing the result of the ListVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumes

      default CompletableFuture<ListVolumesResponse> listVolumes(Consumer<ListVolumesRequest.Builder> listVolumesRequest)

      Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

      The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.


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

      Parameters:
      listVolumesRequest - A Consumer that will call methods on ListVolumesRequest.Builder to create a request. A JSON object that contains one or more of the following fields:

      Returns:
      A Java Future containing the result of the ListVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumes

      default CompletableFuture<ListVolumesResponse> listVolumes()

      Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

      The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

      Returns:
      A Java Future containing the result of the ListVolumes 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumesPaginator

      default ListVolumesPublisher listVolumesPaginator()

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

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumesPaginator

      default ListVolumesPublisher listVolumesPaginator(ListVolumesRequest listVolumesRequest)

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

      Parameters:
      listVolumesRequest - A JSON object that contains one or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVolumesPaginator

      default ListVolumesPublisher listVolumesPaginator(Consumer<ListVolumesRequest.Builder> listVolumesRequest)

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


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

      Parameters:
      listVolumesRequest - A Consumer that will call methods on ListVolumesRequest.Builder to create a request. A JSON object that contains one or more of the following fields:

      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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyWhenUploaded

      default CompletableFuture<NotifyWhenUploadedResponse> notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest)

      Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

      Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

      For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.

      Parameters:
      notifyWhenUploadedRequest -
      Returns:
      A Java Future containing the result of the NotifyWhenUploaded 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyWhenUploaded

      default CompletableFuture<NotifyWhenUploadedResponse> notifyWhenUploaded(Consumer<NotifyWhenUploadedRequest.Builder> notifyWhenUploadedRequest)

      Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

      Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

      For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.


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

      Parameters:
      notifyWhenUploadedRequest - A Consumer that will call methods on NotifyWhenUploadedRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the NotifyWhenUploaded 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshCache

      default CompletableFuture<RefreshCacheResponse> refreshCache(RefreshCacheRequest refreshCacheRequest)

      Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.

      You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.

      When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.

      Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.

      • Wait at least 60 seconds between consecutive RefreshCache API requests.

      • If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

      The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.

      For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.

      Parameters:
      refreshCacheRequest - RefreshCacheInput
      Returns:
      A Java Future containing the result of the RefreshCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshCache

      default CompletableFuture<RefreshCacheResponse> refreshCache(Consumer<RefreshCacheRequest.Builder> refreshCacheRequest)

      Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.

      You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.

      When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.

      Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.

      • Wait at least 60 seconds between consecutive RefreshCache API requests.

      • If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

      The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.

      For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.


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

      Parameters:
      refreshCacheRequest - A Consumer that will call methods on RefreshCacheRequest.Builder to create a request. RefreshCacheInput
      Returns:
      A Java Future containing the result of the RefreshCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

      Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.

      Parameters:
      removeTagsFromResourceRequest - RemoveTagsFromResourceInput
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)

      Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.


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

      Parameters:
      removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request. RemoveTagsFromResourceInput
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetCache

      default CompletableFuture<ResetCacheResponse> resetCache(ResetCacheRequest resetCacheRequest)

      Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

      If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

      Parameters:
      resetCacheRequest -
      Returns:
      A Java Future containing the result of the ResetCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetCache

      default CompletableFuture<ResetCacheResponse> resetCache(Consumer<ResetCacheRequest.Builder> resetCacheRequest)

      Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

      If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.


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

      Parameters:
      resetCacheRequest - A Consumer that will call methods on ResetCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetCache 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieveTapeArchive

      default CompletableFuture<RetrieveTapeArchiveResponse> retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)

      Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

      Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

      Parameters:
      retrieveTapeArchiveRequest - RetrieveTapeArchiveInput
      Returns:
      A Java Future containing the result of the RetrieveTapeArchive 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieveTapeArchive

      default CompletableFuture<RetrieveTapeArchiveResponse> retrieveTapeArchive(Consumer<RetrieveTapeArchiveRequest.Builder> retrieveTapeArchiveRequest)

      Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

      Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.


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

      Parameters:
      retrieveTapeArchiveRequest - A Consumer that will call methods on RetrieveTapeArchiveRequest.Builder to create a request. RetrieveTapeArchiveInput
      Returns:
      A Java Future containing the result of the RetrieveTapeArchive 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieveTapeRecoveryPoint

      default CompletableFuture<RetrieveTapeRecoveryPointResponse> retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)

      Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

      A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

      The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

      Parameters:
      retrieveTapeRecoveryPointRequest - RetrieveTapeRecoveryPointInput
      Returns:
      A Java Future containing the result of the RetrieveTapeRecoveryPoint 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieveTapeRecoveryPoint

      default CompletableFuture<RetrieveTapeRecoveryPointResponse> retrieveTapeRecoveryPoint(Consumer<RetrieveTapeRecoveryPointRequest.Builder> retrieveTapeRecoveryPointRequest)

      Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

      A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

      The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.


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

      Parameters:
      retrieveTapeRecoveryPointRequest - A Consumer that will call methods on RetrieveTapeRecoveryPointRequest.Builder to create a request. RetrieveTapeRecoveryPointInput
      Returns:
      A Java Future containing the result of the RetrieveTapeRecoveryPoint 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setLocalConsolePassword

      default CompletableFuture<SetLocalConsolePasswordResponse> setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)

      Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

      Parameters:
      setLocalConsolePasswordRequest - SetLocalConsolePasswordInput
      Returns:
      A Java Future containing the result of the SetLocalConsolePassword 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setLocalConsolePassword

      default CompletableFuture<SetLocalConsolePasswordResponse> setLocalConsolePassword(Consumer<SetLocalConsolePasswordRequest.Builder> setLocalConsolePasswordRequest)

      Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.


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

      Parameters:
      setLocalConsolePasswordRequest - A Consumer that will call methods on SetLocalConsolePasswordRequest.Builder to create a request. SetLocalConsolePasswordInput
      Returns:
      A Java Future containing the result of the SetLocalConsolePassword 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setSMBGuestPassword

      default CompletableFuture<SetSmbGuestPasswordResponse> setSMBGuestPassword(SetSmbGuestPasswordRequest setSmbGuestPasswordRequest)

      Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 File Gateways

      Parameters:
      setSmbGuestPasswordRequest - SetSMBGuestPasswordInput
      Returns:
      A Java Future containing the result of the SetSMBGuestPassword 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setSMBGuestPassword

      default CompletableFuture<SetSmbGuestPasswordResponse> setSMBGuestPassword(Consumer<SetSmbGuestPasswordRequest.Builder> setSmbGuestPasswordRequest)

      Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 File Gateways


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

      Parameters:
      setSmbGuestPasswordRequest - A Consumer that will call methods on SetSmbGuestPasswordRequest.Builder to create a request. SetSMBGuestPasswordInput
      Returns:
      A Java Future containing the result of the SetSMBGuestPassword 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • shutdownGateway

      default CompletableFuture<ShutdownGatewayResponse> shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)

      Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

      This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.

      The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

      If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

      After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

      When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

      If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

      Parameters:
      shutdownGatewayRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
      Returns:
      A Java Future containing the result of the ShutdownGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • shutdownGateway

      default CompletableFuture<ShutdownGatewayResponse> shutdownGateway(Consumer<ShutdownGatewayRequest.Builder> shutdownGatewayRequest)

      Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

      This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.

      The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

      If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

      After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

      When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

      If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.


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

      Parameters:
      shutdownGatewayRequest - A Consumer that will call methods on ShutdownGatewayRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
      Returns:
      A Java Future containing the result of the ShutdownGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAvailabilityMonitorTest

      default CompletableFuture<StartAvailabilityMonitorTestResponse> startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest)

      Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

      Starting this test will cause your gateway to go offline for a brief period.

      Parameters:
      startAvailabilityMonitorTestRequest -
      Returns:
      A Java Future containing the result of the StartAvailabilityMonitorTest 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAvailabilityMonitorTest

      default CompletableFuture<StartAvailabilityMonitorTestResponse> startAvailabilityMonitorTest(Consumer<StartAvailabilityMonitorTestRequest.Builder> startAvailabilityMonitorTestRequest)

      Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

      Starting this test will cause your gateway to go offline for a brief period.


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

      Parameters:
      startAvailabilityMonitorTestRequest - A Consumer that will call methods on StartAvailabilityMonitorTestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartAvailabilityMonitorTest 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startGateway

      default CompletableFuture<StartGatewayResponse> startGateway(StartGatewayRequest startGatewayRequest)

      Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

      When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

      To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      startGatewayRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
      Returns:
      A Java Future containing the result of the StartGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startGateway

      default CompletableFuture<StartGatewayResponse> startGateway(Consumer<StartGatewayRequest.Builder> startGatewayRequest)

      Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

      When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

      To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      startGatewayRequest - A Consumer that will call methods on StartGatewayRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
      Returns:
      A Java Future containing the result of the StartGateway 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAutomaticTapeCreationPolicy

      default CompletableFuture<UpdateAutomaticTapeCreationPolicyResponse> updateAutomaticTapeCreationPolicy(UpdateAutomaticTapeCreationPolicyRequest updateAutomaticTapeCreationPolicyRequest)

      Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

      By default, there is no automatic tape creation policy.

      A gateway can have only one automatic tape creation policy.

      Parameters:
      updateAutomaticTapeCreationPolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateAutomaticTapeCreationPolicy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAutomaticTapeCreationPolicy

      default CompletableFuture<UpdateAutomaticTapeCreationPolicyResponse> updateAutomaticTapeCreationPolicy(Consumer<UpdateAutomaticTapeCreationPolicyRequest.Builder> updateAutomaticTapeCreationPolicyRequest)

      Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

      By default, there is no automatic tape creation policy.

      A gateway can have only one automatic tape creation policy.


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

      Parameters:
      updateAutomaticTapeCreationPolicyRequest - A Consumer that will call methods on UpdateAutomaticTapeCreationPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAutomaticTapeCreationPolicy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBandwidthRateLimit

      default CompletableFuture<UpdateBandwidthRateLimitResponse> updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)

      Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.

      By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

      To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

      Parameters:
      updateBandwidthRateLimitRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBandwidthRateLimit

      default CompletableFuture<UpdateBandwidthRateLimitResponse> updateBandwidthRateLimit(Consumer<UpdateBandwidthRateLimitRequest.Builder> updateBandwidthRateLimitRequest)

      Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.

      By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

      To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.


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

      Parameters:
      updateBandwidthRateLimitRequest - A Consumer that will call methods on UpdateBandwidthRateLimitRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateBandwidthRateLimit 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBandwidthRateLimitSchedule

      default CompletableFuture<UpdateBandwidthRateLimitScheduleResponse> updateBandwidthRateLimitSchedule(UpdateBandwidthRateLimitScheduleRequest updateBandwidthRateLimitScheduleRequest)

      Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.

      Parameters:
      updateBandwidthRateLimitScheduleRequest -
      Returns:
      A Java Future containing the result of the UpdateBandwidthRateLimitSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBandwidthRateLimitSchedule

      default CompletableFuture<UpdateBandwidthRateLimitScheduleResponse> updateBandwidthRateLimitSchedule(Consumer<UpdateBandwidthRateLimitScheduleRequest.Builder> updateBandwidthRateLimitScheduleRequest)

      Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.


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

      Parameters:
      updateBandwidthRateLimitScheduleRequest - A Consumer that will call methods on UpdateBandwidthRateLimitScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBandwidthRateLimitSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChapCredentials

      default CompletableFuture<UpdateChapCredentialsResponse> updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)

      Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.

      When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

      Parameters:
      updateChapCredentialsRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChapCredentials

      default CompletableFuture<UpdateChapCredentialsResponse> updateChapCredentials(Consumer<UpdateChapCredentialsRequest.Builder> updateChapCredentialsRequest)

      Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.

      When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.


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

      Parameters:
      updateChapCredentialsRequest - A Consumer that will call methods on UpdateChapCredentialsRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateChapCredentials 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystemAssociation

      default CompletableFuture<UpdateFileSystemAssociationResponse> updateFileSystemAssociation(UpdateFileSystemAssociationRequest updateFileSystemAssociationRequest)

      Updates a file system association. This operation is only supported in the FSx File Gateways.

      Parameters:
      updateFileSystemAssociationRequest -
      Returns:
      A Java Future containing the result of the UpdateFileSystemAssociation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystemAssociation

      default CompletableFuture<UpdateFileSystemAssociationResponse> updateFileSystemAssociation(Consumer<UpdateFileSystemAssociationRequest.Builder> updateFileSystemAssociationRequest)

      Updates a file system association. This operation is only supported in the FSx File Gateways.


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

      Parameters:
      updateFileSystemAssociationRequest - A Consumer that will call methods on UpdateFileSystemAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFileSystemAssociation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayInformation

      default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)

      Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

      For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

      Parameters:
      updateGatewayInformationRequest -
      Returns:
      A Java Future containing the result of the UpdateGatewayInformation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewayInformation

      default CompletableFuture<UpdateGatewayInformationResponse> updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)

      Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

      For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.


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

      Parameters:
      updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGatewayInformation 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewaySoftwareNow

      default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)

      Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

      When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

      A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.

      Parameters:
      updateGatewaySoftwareNowRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
      Returns:
      A Java Future containing the result of the UpdateGatewaySoftwareNow 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGatewaySoftwareNow

      default CompletableFuture<UpdateGatewaySoftwareNowResponse> updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest)

      Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

      When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

      A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.


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

      Parameters:
      updateGatewaySoftwareNowRequest - A Consumer that will call methods on UpdateGatewaySoftwareNowRequest.Builder to create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
      Returns:
      A Java Future containing the result of the UpdateGatewaySoftwareNow 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceStartTime

      default CompletableFuture<UpdateMaintenanceStartTimeResponse> updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)

      Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

      Parameters:
      updateMaintenanceStartTimeRequest - A JSON object containing the following fields:

      Returns:
      A Java Future containing the result of the UpdateMaintenanceStartTime 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMaintenanceStartTime

      default CompletableFuture<UpdateMaintenanceStartTimeResponse> updateMaintenanceStartTime(Consumer<UpdateMaintenanceStartTimeRequest.Builder> updateMaintenanceStartTimeRequest)

      Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.


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

      Parameters:
      updateMaintenanceStartTimeRequest - A Consumer that will call methods on UpdateMaintenanceStartTimeRequest.Builder to create a request. A JSON object containing the following fields:

      Returns:
      A Java Future containing the result of the UpdateMaintenanceStartTime 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNFSFileShare

      default CompletableFuture<UpdateNfsFileShareResponse> updateNFSFileShare(UpdateNfsFileShareRequest updateNfsFileShareRequest)

      Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

      To leave a file share field unchanged, set the corresponding input field to null.

      Updates the following file share settings:

      • Default storage class for your S3 bucket

      • Metadata defaults for your S3 bucket

      • Allowed NFS clients for your file share

      • Squash settings

      • Write status of your file share

      Parameters:
      updateNfsFileShareRequest - UpdateNFSFileShareInput
      Returns:
      A Java Future containing the result of the UpdateNFSFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNFSFileShare

      default CompletableFuture<UpdateNfsFileShareResponse> updateNFSFileShare(Consumer<UpdateNfsFileShareRequest.Builder> updateNfsFileShareRequest)

      Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

      To leave a file share field unchanged, set the corresponding input field to null.

      Updates the following file share settings:

      • Default storage class for your S3 bucket

      • Metadata defaults for your S3 bucket

      • Allowed NFS clients for your file share

      • Squash settings

      • Write status of your file share


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

      Parameters:
      updateNfsFileShareRequest - A Consumer that will call methods on UpdateNfsFileShareRequest.Builder to create a request. UpdateNFSFileShareInput
      Returns:
      A Java Future containing the result of the UpdateNFSFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBFileShare

      default CompletableFuture<UpdateSmbFileShareResponse> updateSMBFileShare(UpdateSmbFileShareRequest updateSmbFileShareRequest)

      Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

      To leave a file share field unchanged, set the corresponding input field to null.

      File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.

      Parameters:
      updateSmbFileShareRequest - UpdateSMBFileShareInput
      Returns:
      A Java Future containing the result of the UpdateSMBFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBFileShare

      default CompletableFuture<UpdateSmbFileShareResponse> updateSMBFileShare(Consumer<UpdateSmbFileShareRequest.Builder> updateSmbFileShareRequest)

      Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

      To leave a file share field unchanged, set the corresponding input field to null.

      File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.


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

      Parameters:
      updateSmbFileShareRequest - A Consumer that will call methods on UpdateSmbFileShareRequest.Builder to create a request. UpdateSMBFileShareInput
      Returns:
      A Java Future containing the result of the UpdateSMBFileShare 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBFileShareVisibility

      default CompletableFuture<UpdateSmbFileShareVisibilityResponse> updateSMBFileShareVisibility(UpdateSmbFileShareVisibilityRequest updateSmbFileShareVisibilityRequest)

      Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.

      Parameters:
      updateSmbFileShareVisibilityRequest -
      Returns:
      A Java Future containing the result of the UpdateSMBFileShareVisibility 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBFileShareVisibility

      default CompletableFuture<UpdateSmbFileShareVisibilityResponse> updateSMBFileShareVisibility(Consumer<UpdateSmbFileShareVisibilityRequest.Builder> updateSmbFileShareVisibilityRequest)

      Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.


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

      Parameters:
      updateSmbFileShareVisibilityRequest - A Consumer that will call methods on UpdateSmbFileShareVisibilityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSMBFileShareVisibility 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBLocalGroups

      default CompletableFuture<UpdateSmbLocalGroupsResponse> updateSMBLocalGroups(UpdateSmbLocalGroupsRequest updateSmbLocalGroupsRequest)

      Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

      Parameters:
      updateSmbLocalGroupsRequest -
      Returns:
      A Java Future containing the result of the UpdateSMBLocalGroups 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBLocalGroups

      default CompletableFuture<UpdateSmbLocalGroupsResponse> updateSMBLocalGroups(Consumer<UpdateSmbLocalGroupsRequest.Builder> updateSmbLocalGroupsRequest)

      Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.


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

      Parameters:
      updateSmbLocalGroupsRequest - A Consumer that will call methods on UpdateSmbLocalGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSMBLocalGroups 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBSecurityStrategy

      default CompletableFuture<UpdateSmbSecurityStrategyResponse> updateSMBSecurityStrategy(UpdateSmbSecurityStrategyRequest updateSmbSecurityStrategyRequest)

      Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

      This API is called Security level in the User Guide.

      A higher security level can affect performance of the gateway.

      Parameters:
      updateSmbSecurityStrategyRequest -
      Returns:
      A Java Future containing the result of the UpdateSMBSecurityStrategy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSMBSecurityStrategy

      default CompletableFuture<UpdateSmbSecurityStrategyResponse> updateSMBSecurityStrategy(Consumer<UpdateSmbSecurityStrategyRequest.Builder> updateSmbSecurityStrategyRequest)

      Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

      This API is called Security level in the User Guide.

      A higher security level can affect performance of the gateway.


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

      Parameters:
      updateSmbSecurityStrategyRequest - A Consumer that will call methods on UpdateSmbSecurityStrategyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSMBSecurityStrategy 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSnapshotSchedule

      default CompletableFuture<UpdateSnapshotScheduleResponse> updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)

      Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

      The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

      In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

      Parameters:
      updateSnapshotScheduleRequest - A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSnapshotSchedule

      default CompletableFuture<UpdateSnapshotScheduleResponse> updateSnapshotSchedule(Consumer<UpdateSnapshotScheduleRequest.Builder> updateSnapshotScheduleRequest)

      Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

      The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

      In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.


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

      Parameters:
      updateSnapshotScheduleRequest - A Consumer that will call methods on UpdateSnapshotScheduleRequest.Builder to create a request. A JSON object containing one or more of the following fields:

      Returns:
      A Java Future containing the result of the UpdateSnapshotSchedule 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVTLDeviceType

      default CompletableFuture<UpdateVtlDeviceTypeResponse> updateVTLDeviceType(UpdateVtlDeviceTypeRequest updateVtlDeviceTypeRequest)

      Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

      Parameters:
      updateVtlDeviceTypeRequest -
      Returns:
      A Java Future containing the result of the UpdateVTLDeviceType 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVTLDeviceType

      default CompletableFuture<UpdateVtlDeviceTypeResponse> updateVTLDeviceType(Consumer<UpdateVtlDeviceTypeRequest.Builder> updateVtlDeviceTypeRequest)

      Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.


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

      Parameters:
      updateVtlDeviceTypeRequest - A Consumer that will call methods on UpdateVtlDeviceTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVTLDeviceType 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.
      • InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
      • InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static StorageGatewayAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a StorageGatewayAsyncClient.