Class AWSStorageGatewayAsyncClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.storagegateway.AWSStorageGatewayClient
-
- com.amazonaws.services.storagegateway.AWSStorageGatewayAsyncClient
-
- All Implemented Interfaces:
AWSStorageGateway
,AWSStorageGatewayAsync
public class AWSStorageGatewayAsyncClient extends AWSStorageGatewayClient implements AWSStorageGatewayAsync
Interface for accessing AWS Storage Gateway asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept anAsyncHandler
can be used to receive notification when an asynchronous operation completes.AWS Storage Gateway Service AWS 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 AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
-
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
-
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
-
Error Responses: Provides reference information about AWS Storage Gateway errors.
-
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
-
AWS Storage Gateway Regions and Endpoints: Provides a list of each of the s and endpoints available for use with AWS Storage Gateway.
AWS 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-1122AABB
. When you use this ID with the EC2 API, you must change it tovol-1122aabb
. 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 ARN with the longer volume ID format will look like this:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG
.A snapshot ID with the longer ID format will look like this:
snap-78e226633445566ee
.For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
-
-
Field Summary
-
Fields inherited from class com.amazonaws.services.storagegateway.AWSStorageGatewayClient
configFactory
-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AWSStorageGatewayAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway.AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials.AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider.AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the provided AWS account credentials provider and client configuration options.AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider, executor service, and client configuration options.AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider and executor service.AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials, executor service, and client configuration options.AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials and executor service.AWSStorageGatewayAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway.
-
Method Summary
-
Methods inherited from class com.amazonaws.services.storagegateway.AWSStorageGatewayClient
activateGateway, addCache, addTagsToResource, addUploadBuffer, addWorkingStorage, cancelArchival, cancelRetrieval, createCachediSCSIVolume, createSnapshot, createSnapshotFromVolumeRecoveryPoint, createStorediSCSIVolume, createTapes, createTapeWithBarcode, deleteBandwidthRateLimit, deleteChapCredentials, deleteGateway, deleteSnapshotSchedule, deleteTape, deleteTapeArchive, deleteVolume, describeBandwidthRateLimit, describeCache, describeCachediSCSIVolumes, describeChapCredentials, describeGatewayInformation, describeMaintenanceStartTime, describeSnapshotSchedule, describeStorediSCSIVolumes, describeTapeArchives, describeTapeArchives, describeTapeRecoveryPoints, describeTapes, describeUploadBuffer, describeVTLDevices, describeWorkingStorage, disableGateway, getCachedResponseMetadata, listGateways, listGateways, listLocalDisks, listTagsForResource, listTagsForResource, listTapes, listVolumeInitiators, listVolumeRecoveryPoints, listVolumes, removeTagsFromResource, removeTagsFromResource, resetCache, retrieveTapeArchive, retrieveTapeRecoveryPoint, setLocalConsolePassword, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule, updateVTLDeviceType
-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.storagegateway.AWSStorageGateway
activateGateway, addCache, addTagsToResource, addUploadBuffer, addWorkingStorage, cancelArchival, cancelRetrieval, createCachediSCSIVolume, createSnapshot, createSnapshotFromVolumeRecoveryPoint, createStorediSCSIVolume, createTapes, createTapeWithBarcode, deleteBandwidthRateLimit, deleteChapCredentials, deleteGateway, deleteSnapshotSchedule, deleteTape, deleteTapeArchive, deleteVolume, describeBandwidthRateLimit, describeCache, describeCachediSCSIVolumes, describeChapCredentials, describeGatewayInformation, describeMaintenanceStartTime, describeSnapshotSchedule, describeStorediSCSIVolumes, describeTapeArchives, describeTapeArchives, describeTapeRecoveryPoints, describeTapes, describeUploadBuffer, describeVTLDevices, describeWorkingStorage, disableGateway, getCachedResponseMetadata, listGateways, listGateways, listLocalDisks, listTagsForResource, listTagsForResource, listTapes, listVolumeInitiators, listVolumeRecoveryPoints, listVolumes, removeTagsFromResource, removeTagsFromResource, resetCache, retrieveTapeArchive, retrieveTapeRecoveryPoint, setEndpoint, setLocalConsolePassword, setRegion, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule, updateVTLDeviceType
-
-
-
-
Constructor Detail
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via
ClientConfiguration.getMaxConnections()
.- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to AWS Storage Gateway (ex: proxy settings, retry counts, etc).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials.Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials and executor service. Default client settings will be used.- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials, executor service, and client configuration options.- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider. Default client settings will be used.Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the provided AWS account credentials provider and client configuration options.Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via
ClientConfiguration.getMaxConnections()
.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider and executor service. Default client settings will be used.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSStorageGatewayAsyncClient
public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Storage Gateway using the specified AWS account credentials provider, executor service, and client configuration options.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.
-
-
Method Detail
-
getExecutorService
public ExecutorService getExecutorService()
Returns the executor service used by this client to execute async requests.- Returns:
- The executor service used by this client to execute async requests.
-
activateGatewayAsync
public Future<ActivateGatewayResult> activateGatewayAsync(ActivateGatewayRequest request)
Description copied from interface:AWSStorageGatewayAsync
Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, 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.
- Specified by:
activateGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
activateGatewayAsync
public Future<ActivateGatewayResult> activateGatewayAsync(ActivateGatewayRequest request, AsyncHandler<ActivateGatewayRequest,ActivateGatewayResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, 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.
- Specified by:
activateGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ActivateGateway operation returned by the service.
-
addCacheAsync
public Future<AddCacheResult> addCacheAsync(AddCacheRequest request)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).
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.
- Specified by:
addCacheAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the AddCache operation returned by the service.
-
addCacheAsync
public Future<AddCacheResult> addCacheAsync(AddCacheRequest request, AsyncHandler<AddCacheRequest,AddCacheResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).
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.
- Specified by:
addCacheAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddCache operation returned by the service.
-
addTagsToResourceAsync
public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 AWS Storage Gateway resources:
-
Storage gateways of all types
-
Storage Volumes
-
Virtual Tapes
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
- Specified by:
addTagsToResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- AddTagsToResourceInput- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
-
-
addTagsToResourceAsync
public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 AWS Storage Gateway resources:
-
Storage gateways of all types
-
Storage Volumes
-
Virtual Tapes
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
- Specified by:
addTagsToResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- AddTagsToResourceInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
-
-
addUploadBufferAsync
public Future<AddUploadBufferResult> addUploadBufferAsync(AddUploadBufferRequest request)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
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.
- Specified by:
addUploadBufferAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the AddUploadBuffer operation returned by the service.
-
addUploadBufferAsync
public Future<AddUploadBufferResult> addUploadBufferAsync(AddUploadBufferRequest request, AsyncHandler<AddUploadBufferRequest,AddUploadBufferResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
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.
- Specified by:
addUploadBufferAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddUploadBuffer operation returned by the service.
-
addWorkingStorageAsync
public Future<AddWorkingStorageResult> addWorkingStorageAsync(AddWorkingStorageRequest request)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes 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.
- Specified by:
addWorkingStorageAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
addWorkingStorageAsync
public Future<AddWorkingStorageResult> addWorkingStorageAsync(AddWorkingStorageRequest request, AsyncHandler<AddWorkingStorageRequest,AddWorkingStorageResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes 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.
- Specified by:
addWorkingStorageAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddWorkingStorage operation returned by the service.
-
cancelArchivalAsync
public Future<CancelArchivalResult> cancelArchivalAsync(CancelArchivalRequest request)
Description copied from interface:AWSStorageGatewayAsync
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
- Specified by:
cancelArchivalAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CancelArchivalInput- Returns:
- A Java Future containing the result of the CancelArchival operation returned by the service.
-
cancelArchivalAsync
public Future<CancelArchivalResult> cancelArchivalAsync(CancelArchivalRequest request, AsyncHandler<CancelArchivalRequest,CancelArchivalResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
- Specified by:
cancelArchivalAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CancelArchivalInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CancelArchival operation returned by the service.
-
cancelRetrievalAsync
public Future<CancelRetrievalResult> cancelRetrievalAsync(CancelRetrievalRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
cancelRetrievalAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CancelRetrievalInput- Returns:
- A Java Future containing the result of the CancelRetrieval operation returned by the service.
-
cancelRetrievalAsync
public Future<CancelRetrievalResult> cancelRetrievalAsync(CancelRetrievalRequest request, AsyncHandler<CancelRetrievalRequest,CancelRetrievalResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
cancelRetrievalAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CancelRetrievalInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CancelRetrieval operation returned by the service.
-
createCachediSCSIVolumeAsync
public Future<CreateCachediSCSIVolumeResult> createCachediSCSIVolumeAsync(CreateCachediSCSIVolumeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
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, AWS Storage Gateway creates the volume and returns information about it 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.
- Specified by:
createCachediSCSIVolumeAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the CreateCachediSCSIVolume operation returned by the service.
-
createCachediSCSIVolumeAsync
public Future<CreateCachediSCSIVolumeResult> createCachediSCSIVolumeAsync(CreateCachediSCSIVolumeRequest request, AsyncHandler<CreateCachediSCSIVolumeRequest,CreateCachediSCSIVolumeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
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, AWS Storage Gateway creates the volume and returns information about it 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.
- Specified by:
createCachediSCSIVolumeAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateCachediSCSIVolume operation returned by the service.
-
createSnapshotAsync
public Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest request)
Description copied from interface:AWSStorageGatewayAsync
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as 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 ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS 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.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 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.
- Specified by:
createSnapshotAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
createSnapshotAsync
public Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest request, AsyncHandler<CreateSnapshotRequest,CreateSnapshotResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as 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 ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS 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.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 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.
- Specified by:
createSnapshotAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateSnapshot operation returned by the service.
-
createSnapshotFromVolumeRecoveryPointAsync
public Future<CreateSnapshotFromVolumeRecoveryPointResult> createSnapshotFromVolumeRecoveryPointAsync(CreateSnapshotFromVolumeRecoveryPointRequest request)
Description copied from interface:AWSStorageGatewayAsync
Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture.
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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS 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.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
- Specified by:
createSnapshotFromVolumeRecoveryPointAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by the service.
-
createSnapshotFromVolumeRecoveryPointAsync
public Future<CreateSnapshotFromVolumeRecoveryPointResult> createSnapshotFromVolumeRecoveryPointAsync(CreateSnapshotFromVolumeRecoveryPointRequest request, AsyncHandler<CreateSnapshotFromVolumeRecoveryPointRequest,CreateSnapshotFromVolumeRecoveryPointResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture.
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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS 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.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
- Specified by:
createSnapshotFromVolumeRecoveryPointAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by the service.
-
createStorediSCSIVolumeAsync
public Future<CreateStorediSCSIVolumeResult> createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
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, AWS Storage 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.
- Specified by:
createStorediSCSIVolumeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
createStorediSCSIVolumeAsync
public Future<CreateStorediSCSIVolumeResult> createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest request, AsyncHandler<CreateStorediSCSIVolumeRequest,CreateStorediSCSIVolumeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
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, AWS Storage 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.
- Specified by:
createStorediSCSIVolumeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateStorediSCSIVolume operation returned by the service.
-
createTapeWithBarcodeAsync
public Future<CreateTapeWithBarcodeResult> createTapeWithBarcodeAsync(CreateTapeWithBarcodeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape.
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.
- Specified by:
createTapeWithBarcodeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CreateTapeWithBarcodeInput- Returns:
- A Java Future containing the result of the CreateTapeWithBarcode operation returned by the service.
-
createTapeWithBarcodeAsync
public Future<CreateTapeWithBarcodeResult> createTapeWithBarcodeAsync(CreateTapeWithBarcodeRequest request, AsyncHandler<CreateTapeWithBarcodeRequest,CreateTapeWithBarcodeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape.
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.
- Specified by:
createTapeWithBarcodeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CreateTapeWithBarcodeInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateTapeWithBarcode operation returned by the service.
-
createTapesAsync
public Future<CreateTapesResult> createTapesAsync(CreateTapesRequest request)
Description copied from interface:AWSStorageGatewayAsync
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
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.
- Specified by:
createTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CreateTapesInput- Returns:
- A Java Future containing the result of the CreateTapes operation returned by the service.
-
createTapesAsync
public Future<CreateTapesResult> createTapesAsync(CreateTapesRequest request, AsyncHandler<CreateTapesRequest,CreateTapesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
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.
- Specified by:
createTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- CreateTapesInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateTapes operation returned by the service.
-
deleteBandwidthRateLimitAsync
public Future<DeleteBandwidthRateLimitResult> deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
deleteBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the DeleteBandwidthRateLimit operation returned by the service.
-
deleteBandwidthRateLimitAsync
public Future<DeleteBandwidthRateLimitResult> deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest request, AsyncHandler<DeleteBandwidthRateLimitRequest,DeleteBandwidthRateLimitResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
deleteBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteBandwidthRateLimit operation returned by the service.
-
deleteChapCredentialsAsync
public Future<DeleteChapCredentialsResult> deleteChapCredentialsAsync(DeleteChapCredentialsRequest request)
Description copied from interface:AWSStorageGatewayAsync
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
- Specified by:
deleteChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
deleteChapCredentialsAsync
public Future<DeleteChapCredentialsResult> deleteChapCredentialsAsync(DeleteChapCredentialsRequest request, AsyncHandler<DeleteChapCredentialsRequest,DeleteChapCredentialsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
- Specified by:
deleteChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteChapCredentials operation returned by the service.
-
deleteGatewayAsync
public Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 AWS Storage Gateway Detail Page.
- Specified by:
deleteGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
deleteGatewayAsync
public Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest request, AsyncHandler<DeleteGatewayRequest,DeleteGatewayResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 AWS Storage Gateway Detail Page.
- Specified by:
deleteGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the id of the gateway to delete.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteGateway operation returned by the service.
-
deleteSnapshotScheduleAsync
public Future<DeleteSnapshotScheduleResult> deleteSnapshotScheduleAsync(DeleteSnapshotScheduleRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 Working with Snapshots. In the
DeleteSnapshotSchedule
request, you identify the volume by providing its Amazon Resource Name (ARN).To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
- Specified by:
deleteSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
-
deleteSnapshotScheduleAsync
public Future<DeleteSnapshotScheduleResult> deleteSnapshotScheduleAsync(DeleteSnapshotScheduleRequest request, AsyncHandler<DeleteSnapshotScheduleRequest,DeleteSnapshotScheduleResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 Working with Snapshots. In the
DeleteSnapshotSchedule
request, you identify the volume by providing its Amazon Resource Name (ARN).To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
- Specified by:
deleteSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
-
deleteTapeAsync
public Future<DeleteTapeResult> deleteTapeAsync(DeleteTapeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified virtual tape.
- Specified by:
deleteTapeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DeleteTapeInput- Returns:
- A Java Future containing the result of the DeleteTape operation returned by the service.
-
deleteTapeAsync
public Future<DeleteTapeResult> deleteTapeAsync(DeleteTapeRequest request, AsyncHandler<DeleteTapeRequest,DeleteTapeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified virtual tape.
- Specified by:
deleteTapeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DeleteTapeInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteTape operation returned by the service.
-
deleteTapeArchiveAsync
public Future<DeleteTapeArchiveResult> deleteTapeArchiveAsync(DeleteTapeArchiveRequest request)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified virtual tape from the virtual tape shelf (VTS).
- Specified by:
deleteTapeArchiveAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DeleteTapeArchiveInput- Returns:
- A Java Future containing the result of the DeleteTapeArchive operation returned by the service.
-
deleteTapeArchiveAsync
public Future<DeleteTapeArchiveResult> deleteTapeArchiveAsync(DeleteTapeArchiveRequest request, AsyncHandler<DeleteTapeArchiveRequest,DeleteTapeArchiveResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified virtual tape from the virtual tape shelf (VTS).
- Specified by:
deleteTapeArchiveAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DeleteTapeArchiveInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteTapeArchive operation returned by the service.
-
deleteVolumeAsync
public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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.
- Specified by:
deleteVolumeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the DeleteVolumeInput$VolumeARN to delete.- Returns:
- A Java Future containing the result of the DeleteVolume operation returned by the service.
-
deleteVolumeAsync
public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request, AsyncHandler<DeleteVolumeRequest,DeleteVolumeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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.
- Specified by:
deleteVolumeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the DeleteVolumeInput$VolumeARN to delete.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteVolume operation returned by the service.
-
describeBandwidthRateLimitAsync
public Future<DescribeBandwidthRateLimitResult> describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 only 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.
- Specified by:
describeBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.- Returns:
- A Java Future containing the result of the DescribeBandwidthRateLimit operation returned by the service.
-
describeBandwidthRateLimitAsync
public Future<DescribeBandwidthRateLimitResult> describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest request, AsyncHandler<DescribeBandwidthRateLimitRequest,DescribeBandwidthRateLimitResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 only 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.
- Specified by:
describeBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeBandwidthRateLimit operation returned by the service.
-
describeCacheAsync
public Future<DescribeCacheResult> describeCacheAsync(DescribeCacheRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
- Specified by:
describeCacheAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the DescribeCache operation returned by the service.
-
describeCacheAsync
public Future<DescribeCacheResult> describeCacheAsync(DescribeCacheRequest request, AsyncHandler<DescribeCacheRequest,DescribeCacheResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
- Specified by:
describeCacheAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeCache operation returned by the service.
-
describeCachediSCSIVolumesAsync
public Future<DescribeCachediSCSIVolumesResult> describeCachediSCSIVolumesAsync(DescribeCachediSCSIVolumesRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
- Specified by:
describeCachediSCSIVolumesAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the DescribeCachediSCSIVolumes operation returned by the service.
-
describeCachediSCSIVolumesAsync
public Future<DescribeCachediSCSIVolumesResult> describeCachediSCSIVolumesAsync(DescribeCachediSCSIVolumesRequest request, AsyncHandler<DescribeCachediSCSIVolumesRequest,DescribeCachediSCSIVolumesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
- Specified by:
describeCachediSCSIVolumesAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeCachediSCSIVolumes operation returned by the service.
-
describeChapCredentialsAsync
public Future<DescribeChapCredentialsResult> describeChapCredentialsAsync(DescribeChapCredentialsRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
- Specified by:
describeChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
describeChapCredentialsAsync
public Future<DescribeChapCredentialsResult> describeChapCredentialsAsync(DescribeChapCredentialsRequest request, AsyncHandler<DescribeChapCredentialsRequest,DescribeChapCredentialsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
- Specified by:
describeChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeChapCredentials operation returned by the service.
-
describeGatewayInformationAsync
public Future<DescribeGatewayInformationResult> describeGatewayInformationAsync(DescribeGatewayInformationRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
- Specified by:
describeGatewayInformationAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
describeGatewayInformationAsync
public Future<DescribeGatewayInformationResult> describeGatewayInformationAsync(DescribeGatewayInformationRequest request, AsyncHandler<DescribeGatewayInformationRequest,DescribeGatewayInformationResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
- Specified by:
describeGatewayInformationAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the id of the gateway.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeGatewayInformation operation returned by the service.
-
describeMaintenanceStartTimeAsync
public Future<DescribeMaintenanceStartTimeResult> describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
describeMaintenanceStartTimeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.- Returns:
- A Java Future containing the result of the DescribeMaintenanceStartTime operation returned by the service.
-
describeMaintenanceStartTimeAsync
public Future<DescribeMaintenanceStartTimeResult> describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest request, AsyncHandler<DescribeMaintenanceStartTimeRequest,DescribeMaintenanceStartTimeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
describeMaintenanceStartTimeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeMaintenanceStartTime operation returned by the service.
-
describeSnapshotScheduleAsync
public Future<DescribeSnapshotScheduleResult> describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest request)
Description copied from interface:AWSStorageGatewayAsync
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
- Specified by:
describeSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.- Returns:
- A Java Future containing the result of the DescribeSnapshotSchedule operation returned by the service.
-
describeSnapshotScheduleAsync
public Future<DescribeSnapshotScheduleResult> describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest request, AsyncHandler<DescribeSnapshotScheduleRequest,DescribeSnapshotScheduleResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
- Specified by:
describeSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeSnapshotSchedule operation returned by the service.
-
describeStorediSCSIVolumesAsync
public Future<DescribeStorediSCSIVolumesResult> describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 Amazon Storage Gateway returns volume information sorted by volume ARNs.
- Specified by:
describeStorediSCSIVolumesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.- Returns:
- A Java Future containing the result of the DescribeStorediSCSIVolumes operation returned by the service.
-
describeStorediSCSIVolumesAsync
public Future<DescribeStorediSCSIVolumesResult> describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest request, AsyncHandler<DescribeStorediSCSIVolumesRequest,DescribeStorediSCSIVolumesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 Amazon Storage Gateway returns volume information sorted by volume ARNs.
- Specified by:
describeStorediSCSIVolumesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeStorediSCSIVolumes operation returned by the service.
-
describeTapeArchivesAsync
public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(DescribeTapeArchivesRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific
TapeARN
is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.- Specified by:
describeTapeArchivesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapeArchivesInput- Returns:
- A Java Future containing the result of the DescribeTapeArchives operation returned by the service.
-
describeTapeArchivesAsync
public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(DescribeTapeArchivesRequest request, AsyncHandler<DescribeTapeArchivesRequest,DescribeTapeArchivesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific
TapeARN
is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.- Specified by:
describeTapeArchivesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapeArchivesInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTapeArchives operation returned by the service.
-
describeTapeArchivesAsync
public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync()
Simplified method form for invoking the DescribeTapeArchives operation.- Specified by:
describeTapeArchivesAsync
in interfaceAWSStorageGatewayAsync
- See Also:
describeTapeArchivesAsync(DescribeTapeArchivesRequest)
-
describeTapeArchivesAsync
public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(AsyncHandler<DescribeTapeArchivesRequest,DescribeTapeArchivesResult> asyncHandler)
Simplified method form for invoking the DescribeTapeArchives operation with an AsyncHandler.- Specified by:
describeTapeArchivesAsync
in interfaceAWSStorageGatewayAsync
- See Also:
describeTapeArchivesAsync(DescribeTapeArchivesRequest, com.amazonaws.handlers.AsyncHandler)
-
describeTapeRecoveryPointsAsync
public Future<DescribeTapeRecoveryPointsResult> describeTapeRecoveryPointsAsync(DescribeTapeRecoveryPointsRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
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.
- Specified by:
describeTapeRecoveryPointsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapeRecoveryPointsInput- Returns:
- A Java Future containing the result of the DescribeTapeRecoveryPoints operation returned by the service.
-
describeTapeRecoveryPointsAsync
public Future<DescribeTapeRecoveryPointsResult> describeTapeRecoveryPointsAsync(DescribeTapeRecoveryPointsRequest request, AsyncHandler<DescribeTapeRecoveryPointsRequest,DescribeTapeRecoveryPointsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
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.
- Specified by:
describeTapeRecoveryPointsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapeRecoveryPointsInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTapeRecoveryPoints operation returned by the service.
-
describeTapesAsync
public Future<DescribeTapesResult> describeTapesAsync(DescribeTapesRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway.- Specified by:
describeTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapesInput- Returns:
- A Java Future containing the result of the DescribeTapes operation returned by the service.
-
describeTapesAsync
public Future<DescribeTapesResult> describeTapesAsync(DescribeTapesRequest request, AsyncHandler<DescribeTapesRequest,DescribeTapesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway.- Specified by:
describeTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeTapesInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTapes operation returned by the service.
-
describeUploadBufferAsync
public Future<DescribeUploadBufferResult> describeUploadBufferAsync(DescribeUploadBufferRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
- Specified by:
describeUploadBufferAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the DescribeUploadBuffer operation returned by the service.
-
describeUploadBufferAsync
public Future<DescribeUploadBufferResult> describeUploadBufferAsync(DescribeUploadBufferRequest request, AsyncHandler<DescribeUploadBufferRequest,DescribeUploadBufferResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
- Specified by:
describeUploadBufferAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeUploadBuffer operation returned by the service.
-
describeVTLDevicesAsync
public Future<DescribeVTLDevicesResult> describeVTLDevicesAsync(DescribeVTLDevicesRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
- Specified by:
describeVTLDevicesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeVTLDevicesInput- Returns:
- A Java Future containing the result of the DescribeVTLDevices operation returned by the service.
-
describeVTLDevicesAsync
public Future<DescribeVTLDevicesResult> describeVTLDevicesAsync(DescribeVTLDevicesRequest request, AsyncHandler<DescribeVTLDevicesRequest,DescribeVTLDevicesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
- Specified by:
describeVTLDevicesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DescribeVTLDevicesInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeVTLDevices operation returned by the service.
-
describeWorkingStorageAsync
public Future<DescribeWorkingStorageResult> describeWorkingStorageAsync(DescribeWorkingStorageRequest request)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. 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.
- Specified by:
describeWorkingStorageAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.- Returns:
- A Java Future containing the result of the DescribeWorkingStorage operation returned by the service.
-
describeWorkingStorageAsync
public Future<DescribeWorkingStorageResult> describeWorkingStorageAsync(DescribeWorkingStorageRequest request, AsyncHandler<DescribeWorkingStorageRequest,DescribeWorkingStorageResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. 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.
- Specified by:
describeWorkingStorageAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeWorkingStorage operation returned by the service.
-
disableGatewayAsync
public Future<DisableGatewayResult> disableGatewayAsync(DisableGatewayRequest request)
Description copied from interface:AWSStorageGatewayAsync
Disables a 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 gateway-VTL that is not reachable or not functioning.
Once a gateway is disabled it cannot be enabled.
- Specified by:
disableGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DisableGatewayInput- Returns:
- A Java Future containing the result of the DisableGateway operation returned by the service.
-
disableGatewayAsync
public Future<DisableGatewayResult> disableGatewayAsync(DisableGatewayRequest request, AsyncHandler<DisableGatewayRequest,DisableGatewayResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Disables a 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 gateway-VTL that is not reachable or not functioning.
Once a gateway is disabled it cannot be enabled.
- Specified by:
disableGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- DisableGatewayInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DisableGateway operation returned by the service.
-
listGatewaysAsync
public Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest request)
Description copied from interface:AWSStorageGatewayAsync
Lists gateways owned by an AWS account in a 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.
- Specified by:
listGatewaysAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
listGatewaysAsync
public Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest request, AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Lists gateways owned by an AWS account in a 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.
- Specified by:
listGatewaysAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing zero or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListGateways operation returned by the service.
-
listGatewaysAsync
public Future<ListGatewaysResult> listGatewaysAsync()
Simplified method form for invoking the ListGateways operation.- Specified by:
listGatewaysAsync
in interfaceAWSStorageGatewayAsync
- See Also:
listGatewaysAsync(ListGatewaysRequest)
-
listGatewaysAsync
public Future<ListGatewaysResult> listGatewaysAsync(AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
Simplified method form for invoking the ListGateways operation with an AsyncHandler.- Specified by:
listGatewaysAsync
in interfaceAWSStorageGatewayAsync
- See Also:
listGatewaysAsync(ListGatewaysRequest, com.amazonaws.handlers.AsyncHandler)
-
listLocalDisksAsync
public Future<ListLocalDisksResult> listLocalDisksAsync(ListLocalDisksRequest request)
Description copied from interface:AWSStorageGatewayAsync
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).- Specified by:
listLocalDisksAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.- Returns:
- A Java Future containing the result of the ListLocalDisks operation returned by the service.
-
listLocalDisksAsync
public Future<ListLocalDisksResult> listLocalDisksAsync(ListLocalDisksRequest request, AsyncHandler<ListLocalDisksRequest,ListLocalDisksResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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).- Specified by:
listLocalDisksAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListLocalDisks operation returned by the service.
-
listTagsForResourceAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
Description copied from interface:AWSStorageGatewayAsync
Lists the tags that have been added to the specified resource.
- Specified by:
listTagsForResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- ListTagsForResourceInput- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
-
listTagsForResourceAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Lists the tags that have been added to the specified resource.
- Specified by:
listTagsForResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- ListTagsForResourceInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
-
listTagsForResourceAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync()
Simplified method form for invoking the ListTagsForResource operation.- Specified by:
listTagsForResourceAsync
in interfaceAWSStorageGatewayAsync
- See Also:
listTagsForResourceAsync(ListTagsForResourceRequest)
-
listTagsForResourceAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Simplified method form for invoking the ListTagsForResource operation with an AsyncHandler.- Specified by:
listTagsForResourceAsync
in interfaceAWSStorageGatewayAsync
- See Also:
listTagsForResourceAsync(ListTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler)
-
listTapesAsync
public Future<ListTapesResult> listTapesAsync(ListTapesRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 aMarker
element that you can use in your subsequent request to retrieve the next set of tapes.- Specified by:
listTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
listTapesAsync
public Future<ListTapesResult> listTapesAsync(ListTapesRequest request, AsyncHandler<ListTapesRequest,ListTapesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 aMarker
element that you can use in your subsequent request to retrieve the next set of tapes.- Specified by:
listTapesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object that contains one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListTapes operation returned by the service.
-
listVolumeInitiatorsAsync
public Future<ListVolumeInitiatorsResult> listVolumeInitiatorsAsync(ListVolumeInitiatorsRequest request)
Description copied from interface:AWSStorageGatewayAsync
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
- Specified by:
listVolumeInitiatorsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- ListVolumeInitiatorsInput- Returns:
- A Java Future containing the result of the ListVolumeInitiators operation returned by the service.
-
listVolumeInitiatorsAsync
public Future<ListVolumeInitiatorsResult> listVolumeInitiatorsAsync(ListVolumeInitiatorsRequest request, AsyncHandler<ListVolumeInitiatorsRequest,ListVolumeInitiatorsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
- Specified by:
listVolumeInitiatorsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- ListVolumeInitiatorsInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListVolumeInitiators operation returned by the service.
-
listVolumeRecoveryPointsAsync
public Future<ListVolumeRecoveryPointsResult> listVolumeRecoveryPointsAsync(ListVolumeRecoveryPointsRequest request)
Description copied from interface:AWSStorageGatewayAsync
Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached 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. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
- Specified by:
listVolumeRecoveryPointsAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the ListVolumeRecoveryPoints operation returned by the service.
-
listVolumeRecoveryPointsAsync
public Future<ListVolumeRecoveryPointsResult> listVolumeRecoveryPointsAsync(ListVolumeRecoveryPointsRequest request, AsyncHandler<ListVolumeRecoveryPointsRequest,ListVolumeRecoveryPointsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached 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. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
- Specified by:
listVolumeRecoveryPointsAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListVolumeRecoveryPoints operation returned by the service.
-
listVolumesAsync
public Future<ListVolumesResult> listVolumesAsync(ListVolumesRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 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.- Specified by:
listVolumesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
listVolumesAsync
public Future<ListVolumesResult> listVolumesAsync(ListVolumesRequest request, AsyncHandler<ListVolumesRequest,ListVolumesResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 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.- Specified by:
listVolumesAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object that contains one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListVolumes operation returned by the service.
-
removeTagsFromResourceAsync
public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request)
Description copied from interface:AWSStorageGatewayAsync
Removes one or more tags from the specified resource.
- Specified by:
removeTagsFromResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RemoveTagsFromResourceInput- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
-
removeTagsFromResourceAsync
public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Removes one or more tags from the specified resource.
- Specified by:
removeTagsFromResourceAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RemoveTagsFromResourceInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
-
removeTagsFromResourceAsync
public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync()
Simplified method form for invoking the RemoveTagsFromResource operation.- Specified by:
removeTagsFromResourceAsync
in interfaceAWSStorageGatewayAsync
- See Also:
removeTagsFromResourceAsync(RemoveTagsFromResourceRequest)
-
removeTagsFromResourceAsync
public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
Simplified method form for invoking the RemoveTagsFromResource operation with an AsyncHandler.- Specified by:
removeTagsFromResourceAsync
in interfaceAWSStorageGatewayAsync
- See Also:
removeTagsFromResourceAsync(RemoveTagsFromResourceRequest, com.amazonaws.handlers.AsyncHandler)
-
resetCacheAsync
public Future<ResetCacheResult> resetCacheAsync(ResetCacheRequest request)
Description copied from interface:AWSStorageGatewayAsync
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a 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.
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.
- Specified by:
resetCacheAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the ResetCache operation returned by the service.
-
resetCacheAsync
public Future<ResetCacheResult> resetCacheAsync(ResetCacheRequest request, AsyncHandler<ResetCacheRequest,ResetCacheResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a 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.
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.
- Specified by:
resetCacheAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ResetCache operation returned by the service.
-
retrieveTapeArchiveAsync
public Future<RetrieveTapeArchiveResult> retrieveTapeArchiveAsync(RetrieveTapeArchiveRequest request)
Description copied from interface:AWSStorageGatewayAsync
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. 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.
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.
- Specified by:
retrieveTapeArchiveAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RetrieveTapeArchiveInput- Returns:
- A Java Future containing the result of the RetrieveTapeArchive operation returned by the service.
-
retrieveTapeArchiveAsync
public Future<RetrieveTapeArchiveResult> retrieveTapeArchiveAsync(RetrieveTapeArchiveRequest request, AsyncHandler<RetrieveTapeArchiveRequest,RetrieveTapeArchiveResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. 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.
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.
- Specified by:
retrieveTapeArchiveAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RetrieveTapeArchiveInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RetrieveTapeArchive operation returned by the service.
-
retrieveTapeRecoveryPointAsync
public Future<RetrieveTapeRecoveryPointResult> retrieveTapeRecoveryPointAsync(RetrieveTapeRecoveryPointRequest request)
Description copied from interface:AWSStorageGatewayAsync
Retrieves the recovery point for the specified virtual tape.
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 gateway-VTL. There is no charge for retrieving recovery points.
- Specified by:
retrieveTapeRecoveryPointAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RetrieveTapeRecoveryPointInput- Returns:
- A Java Future containing the result of the RetrieveTapeRecoveryPoint operation returned by the service.
-
retrieveTapeRecoveryPointAsync
public Future<RetrieveTapeRecoveryPointResult> retrieveTapeRecoveryPointAsync(RetrieveTapeRecoveryPointRequest request, AsyncHandler<RetrieveTapeRecoveryPointRequest,RetrieveTapeRecoveryPointResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Retrieves the recovery point for the specified virtual tape.
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 gateway-VTL. There is no charge for retrieving recovery points.
- Specified by:
retrieveTapeRecoveryPointAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- RetrieveTapeRecoveryPointInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RetrieveTapeRecoveryPoint operation returned by the service.
-
setLocalConsolePasswordAsync
public Future<SetLocalConsolePasswordResult> setLocalConsolePasswordAsync(SetLocalConsolePasswordRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
setLocalConsolePasswordAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- SetLocalConsolePasswordInput- Returns:
- A Java Future containing the result of the SetLocalConsolePassword operation returned by the service.
-
setLocalConsolePasswordAsync
public Future<SetLocalConsolePasswordResult> setLocalConsolePasswordAsync(SetLocalConsolePasswordRequest request, AsyncHandler<SetLocalConsolePasswordRequest,SetLocalConsolePasswordResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
setLocalConsolePasswordAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- SetLocalConsolePasswordInputasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the SetLocalConsolePassword operation returned by the service.
-
shutdownGatewayAsync
public Future<ShutdownGatewayResult> shutdownGatewayAsync(ShutdownGatewayRequest request)
Description copied from interface:AWSStorageGatewayAsync
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the 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.
- Specified by:
shutdownGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to shut down.- Returns:
- A Java Future containing the result of the ShutdownGateway operation returned by the service.
-
shutdownGatewayAsync
public Future<ShutdownGatewayResult> shutdownGatewayAsync(ShutdownGatewayRequest request, AsyncHandler<ShutdownGatewayRequest,ShutdownGatewayResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the 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.
- Specified by:
shutdownGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to shut down.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ShutdownGateway operation returned by the service.
-
startGatewayAsync
public Future<StartGatewayResult> startGatewayAsync(StartGatewayRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
startGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to start.- Returns:
- A Java Future containing the result of the StartGateway operation returned by the service.
-
startGatewayAsync
public Future<StartGatewayResult> startGatewayAsync(StartGatewayRequest request, AsyncHandler<StartGatewayRequest,StartGatewayResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
startGatewayAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to start.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the StartGateway operation returned by the service.
-
updateBandwidthRateLimitAsync
public Future<UpdateBandwidthRateLimitResult> updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
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.
- Specified by:
updateBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
updateBandwidthRateLimitAsync
public Future<UpdateBandwidthRateLimitResult> updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest request, AsyncHandler<UpdateBandwidthRateLimitRequest,UpdateBandwidthRateLimitResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
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.
- Specified by:
updateBandwidthRateLimitAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateBandwidthRateLimit operation returned by the service.
-
updateChapCredentialsAsync
public Future<UpdateChapCredentialsResult> updateChapCredentialsAsync(UpdateChapCredentialsRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
- Specified by:
updateChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
updateChapCredentialsAsync
public Future<UpdateChapCredentialsResult> updateChapCredentialsAsync(UpdateChapCredentialsRequest request, AsyncHandler<UpdateChapCredentialsRequest,UpdateChapCredentialsResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
- Specified by:
updateChapCredentialsAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateChapCredentials operation returned by the service.
-
updateGatewayInformationAsync
public Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
updateGatewayInformationAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
-
updateGatewayInformationAsync
public Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest request, AsyncHandler<UpdateGatewayInformationRequest,UpdateGatewayInformationResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
updateGatewayInformationAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
-
updateGatewaySoftwareNowAsync
public Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest request)
Description copied from interface:AWSStorageGatewayAsync
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 theSTATE_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.
- Specified by:
updateGatewaySoftwareNowAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to update.- Returns:
- A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
-
updateGatewaySoftwareNowAsync
public Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest request, AsyncHandler<UpdateGatewaySoftwareNowRequest,UpdateGatewaySoftwareNowResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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 theSTATE_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.
- Specified by:
updateGatewaySoftwareNowAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the of the gateway to update.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
-
updateMaintenanceStartTimeAsync
public Future<UpdateMaintenanceStartTimeResult> updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest request)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
updateMaintenanceStartTimeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the following fields:- Returns:
- A Java Future containing the result of the UpdateMaintenanceStartTime operation returned by the service.
-
updateMaintenanceStartTimeAsync
public Future<UpdateMaintenanceStartTimeResult> updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest request, AsyncHandler<UpdateMaintenanceStartTimeRequest,UpdateMaintenanceStartTimeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
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.
- Specified by:
updateMaintenanceStartTimeAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateMaintenanceStartTime operation returned by the service.
-
updateSnapshotScheduleAsync
public Future<UpdateSnapshotScheduleResult> updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest request)
Description copied from interface:AWSStorageGatewayAsync
Updates a snapshot schedule configured for a gateway volume.
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.
- Specified by:
updateSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
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.
-
updateSnapshotScheduleAsync
public Future<UpdateSnapshotScheduleResult> updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest request, AsyncHandler<UpdateSnapshotScheduleRequest,UpdateSnapshotScheduleResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Updates a snapshot schedule configured for a gateway volume.
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.
- Specified by:
updateSnapshotScheduleAsync
in interfaceAWSStorageGatewayAsync
- Parameters:
request
- A JSON object containing one or more of the following fields:asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateSnapshotSchedule operation returned by the service.
-
updateVTLDeviceTypeAsync
public Future<UpdateVTLDeviceTypeResult> updateVTLDeviceTypeAsync(UpdateVTLDeviceTypeRequest request)
Description copied from interface:AWSStorageGatewayAsync
Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.
- Specified by:
updateVTLDeviceTypeAsync
in interfaceAWSStorageGatewayAsync
- Returns:
- A Java Future containing the result of the UpdateVTLDeviceType operation returned by the service.
-
updateVTLDeviceTypeAsync
public Future<UpdateVTLDeviceTypeResult> updateVTLDeviceTypeAsync(UpdateVTLDeviceTypeRequest request, AsyncHandler<UpdateVTLDeviceTypeRequest,UpdateVTLDeviceTypeResult> asyncHandler)
Description copied from interface:AWSStorageGatewayAsync
Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.
- Specified by:
updateVTLDeviceTypeAsync
in interfaceAWSStorageGatewayAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateVTLDeviceType operation returned by the service.
-
shutdown
public void shutdown()
Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should callgetExecutorService().shutdown()
followed bygetExecutorService().awaitTermination()
prior to calling this method.- Specified by:
shutdown
in interfaceAWSStorageGateway
- Overrides:
shutdown
in classAmazonWebServiceClient
-
-