public class AbstractAWSStorageGatewayAsync extends AbstractAWSStorageGateway implements AWSStorageGatewayAsync
AWSStorageGatewayAsync. Convenient method
forms pass through to the corresponding overload that takes a request object
and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXactivateGateway, 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, shutdown, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule, updateVTLDeviceTypeequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitactivateGateway, 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, shutdown, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule, updateVTLDeviceTypepublic Future<ActivateGatewayResult> activateGatewayAsync(ActivateGatewayRequest request)
AWSStorageGatewayAsyncActivates 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.
activateGatewayAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<ActivateGatewayResult> activateGatewayAsync(ActivateGatewayRequest request, AsyncHandler<ActivateGatewayRequest,ActivateGatewayResult> asyncHandler)
AWSStorageGatewayAsyncActivates 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.
activateGatewayAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<AddCacheResult> addCacheAsync(AddCacheRequest request)
AWSStorageGatewayAsyncConfigures 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.
addCacheAsync in interface AWSStorageGatewayAsyncpublic Future<AddCacheResult> addCacheAsync(AddCacheRequest request, AsyncHandler<AddCacheRequest,AddCacheResult> asyncHandler)
AWSStorageGatewayAsyncConfigures 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.
addCacheAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
AWSStorageGatewayAsyncAdds 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.
addTagsToResourceAsync in interface AWSStorageGatewayAsyncrequest - AddTagsToResourceInputpublic Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
AWSStorageGatewayAsyncAdds 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.
addTagsToResourceAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<AddUploadBufferResult> addUploadBufferAsync(AddUploadBufferRequest request)
AWSStorageGatewayAsyncConfigures 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.
addUploadBufferAsync in interface AWSStorageGatewayAsyncpublic Future<AddUploadBufferResult> addUploadBufferAsync(AddUploadBufferRequest request, AsyncHandler<AddUploadBufferRequest,AddUploadBufferResult> asyncHandler)
AWSStorageGatewayAsyncConfigures 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.
addUploadBufferAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<AddWorkingStorageResult> addWorkingStorageAsync(AddWorkingStorageRequest request)
AWSStorageGatewayAsyncConfigures 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.
addWorkingStorageAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<AddWorkingStorageResult> addWorkingStorageAsync(AddWorkingStorageRequest request, AsyncHandler<AddWorkingStorageRequest,AddWorkingStorageResult> asyncHandler)
AWSStorageGatewayAsyncConfigures 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.
addWorkingStorageAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CancelArchivalResult> cancelArchivalAsync(CancelArchivalRequest request)
AWSStorageGatewayAsyncCancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
cancelArchivalAsync in interface AWSStorageGatewayAsyncrequest - CancelArchivalInputpublic Future<CancelArchivalResult> cancelArchivalAsync(CancelArchivalRequest request, AsyncHandler<CancelArchivalRequest,CancelArchivalResult> asyncHandler)
AWSStorageGatewayAsyncCancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
cancelArchivalAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CancelRetrievalResult> cancelRetrievalAsync(CancelRetrievalRequest request)
AWSStorageGatewayAsyncCancels 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.
cancelRetrievalAsync in interface AWSStorageGatewayAsyncrequest - CancelRetrievalInputpublic Future<CancelRetrievalResult> cancelRetrievalAsync(CancelRetrievalRequest request, AsyncHandler<CancelRetrievalRequest,CancelRetrievalResult> asyncHandler)
AWSStorageGatewayAsyncCancels 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.
cancelRetrievalAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CreateCachediSCSIVolumeResult> createCachediSCSIVolumeAsync(CreateCachediSCSIVolumeRequest request)
AWSStorageGatewayAsyncCreates 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.
createCachediSCSIVolumeAsync in interface AWSStorageGatewayAsyncpublic Future<CreateCachediSCSIVolumeResult> createCachediSCSIVolumeAsync(CreateCachediSCSIVolumeRequest request, AsyncHandler<CreateCachediSCSIVolumeRequest,CreateCachediSCSIVolumeResult> asyncHandler)
AWSStorageGatewayAsyncCreates 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.
createCachediSCSIVolumeAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest request)
AWSStorageGatewayAsyncInitiates 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.
createSnapshotAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest request, AsyncHandler<CreateSnapshotRequest,CreateSnapshotResult> asyncHandler)
AWSStorageGatewayAsyncInitiates 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.
createSnapshotAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CreateSnapshotFromVolumeRecoveryPointResult> createSnapshotFromVolumeRecoveryPointAsync(CreateSnapshotFromVolumeRecoveryPointRequest request)
AWSStorageGatewayAsyncInitiates 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.
createSnapshotFromVolumeRecoveryPointAsync in interface AWSStorageGatewayAsyncpublic Future<CreateSnapshotFromVolumeRecoveryPointResult> createSnapshotFromVolumeRecoveryPointAsync(CreateSnapshotFromVolumeRecoveryPointRequest request, AsyncHandler<CreateSnapshotFromVolumeRecoveryPointRequest,CreateSnapshotFromVolumeRecoveryPointResult> asyncHandler)
AWSStorageGatewayAsyncInitiates 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.
createSnapshotFromVolumeRecoveryPointAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<CreateStorediSCSIVolumeResult> createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest request)
AWSStorageGatewayAsyncCreates 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.
createStorediSCSIVolumeAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<CreateStorediSCSIVolumeResult> createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest request, AsyncHandler<CreateStorediSCSIVolumeRequest,CreateStorediSCSIVolumeResult> asyncHandler)
AWSStorageGatewayAsyncCreates 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.
createStorediSCSIVolumeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CreateTapeWithBarcodeResult> createTapeWithBarcodeAsync(CreateTapeWithBarcodeRequest request)
AWSStorageGatewayAsyncCreates 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.
createTapeWithBarcodeAsync in interface AWSStorageGatewayAsyncrequest - CreateTapeWithBarcodeInputpublic Future<CreateTapeWithBarcodeResult> createTapeWithBarcodeAsync(CreateTapeWithBarcodeRequest request, AsyncHandler<CreateTapeWithBarcodeRequest,CreateTapeWithBarcodeResult> asyncHandler)
AWSStorageGatewayAsyncCreates 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.
createTapeWithBarcodeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<CreateTapesResult> createTapesAsync(CreateTapesRequest request)
AWSStorageGatewayAsyncCreates 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.
createTapesAsync in interface AWSStorageGatewayAsyncrequest - CreateTapesInputpublic Future<CreateTapesResult> createTapesAsync(CreateTapesRequest request, AsyncHandler<CreateTapesRequest,CreateTapesResult> asyncHandler)
AWSStorageGatewayAsyncCreates 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.
createTapesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DeleteBandwidthRateLimitResult> deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest request)
AWSStorageGatewayAsyncDeletes 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.
deleteBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncpublic Future<DeleteBandwidthRateLimitResult> deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest request, AsyncHandler<DeleteBandwidthRateLimitRequest,DeleteBandwidthRateLimitResult> asyncHandler)
AWSStorageGatewayAsyncDeletes 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.
deleteBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<DeleteChapCredentialsResult> deleteChapCredentialsAsync(DeleteChapCredentialsRequest request)
AWSStorageGatewayAsyncDeletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
deleteChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<DeleteChapCredentialsResult> deleteChapCredentialsAsync(DeleteChapCredentialsRequest request, AsyncHandler<DeleteChapCredentialsRequest,DeleteChapCredentialsResult> asyncHandler)
AWSStorageGatewayAsyncDeletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
deleteChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest request)
AWSStorageGatewayAsyncDeletes 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.
deleteGatewayAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the id of the gateway to delete.public Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest request, AsyncHandler<DeleteGatewayRequest,DeleteGatewayResult> asyncHandler)
AWSStorageGatewayAsyncDeletes 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.
deleteGatewayAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DeleteSnapshotScheduleResult> deleteSnapshotScheduleAsync(DeleteSnapshotScheduleRequest request)
AWSStorageGatewayAsyncDeletes 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.
deleteSnapshotScheduleAsync in interface AWSStorageGatewayAsyncpublic Future<DeleteSnapshotScheduleResult> deleteSnapshotScheduleAsync(DeleteSnapshotScheduleRequest request, AsyncHandler<DeleteSnapshotScheduleRequest,DeleteSnapshotScheduleResult> asyncHandler)
AWSStorageGatewayAsyncDeletes 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.
deleteSnapshotScheduleAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<DeleteTapeResult> deleteTapeAsync(DeleteTapeRequest request)
AWSStorageGatewayAsyncDeletes the specified virtual tape.
deleteTapeAsync in interface AWSStorageGatewayAsyncrequest - DeleteTapeInputpublic Future<DeleteTapeResult> deleteTapeAsync(DeleteTapeRequest request, AsyncHandler<DeleteTapeRequest,DeleteTapeResult> asyncHandler)
AWSStorageGatewayAsyncDeletes the specified virtual tape.
deleteTapeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DeleteTapeArchiveResult> deleteTapeArchiveAsync(DeleteTapeArchiveRequest request)
AWSStorageGatewayAsyncDeletes the specified virtual tape from the virtual tape shelf (VTS).
deleteTapeArchiveAsync in interface AWSStorageGatewayAsyncrequest - DeleteTapeArchiveInputpublic Future<DeleteTapeArchiveResult> deleteTapeArchiveAsync(DeleteTapeArchiveRequest request, AsyncHandler<DeleteTapeArchiveRequest,DeleteTapeArchiveResult> asyncHandler)
AWSStorageGatewayAsyncDeletes the specified virtual tape from the virtual tape shelf (VTS).
deleteTapeArchiveAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request)
AWSStorageGatewayAsyncDeletes 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.
deleteVolumeAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the DeleteVolumeInput$VolumeARN to
delete.public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request, AsyncHandler<DeleteVolumeRequest,DeleteVolumeResult> asyncHandler)
AWSStorageGatewayAsyncDeletes 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.
deleteVolumeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeBandwidthRateLimitResult> describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest request)
AWSStorageGatewayAsyncReturns 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.
describeBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway.public Future<DescribeBandwidthRateLimitResult> describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest request, AsyncHandler<DescribeBandwidthRateLimitRequest,DescribeBandwidthRateLimitResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeCacheResult> describeCacheAsync(DescribeCacheRequest request)
AWSStorageGatewayAsyncReturns 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.
describeCacheAsync in interface AWSStorageGatewayAsyncpublic Future<DescribeCacheResult> describeCacheAsync(DescribeCacheRequest request, AsyncHandler<DescribeCacheRequest,DescribeCacheResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeCacheAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<DescribeCachediSCSIVolumesResult> describeCachediSCSIVolumesAsync(DescribeCachediSCSIVolumesRequest request)
AWSStorageGatewayAsyncReturns 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).
describeCachediSCSIVolumesAsync in interface AWSStorageGatewayAsyncpublic Future<DescribeCachediSCSIVolumesResult> describeCachediSCSIVolumesAsync(DescribeCachediSCSIVolumesRequest request, AsyncHandler<DescribeCachediSCSIVolumesRequest,DescribeCachediSCSIVolumesResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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).
describeCachediSCSIVolumesAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<DescribeChapCredentialsResult> describeChapCredentialsAsync(DescribeChapCredentialsRequest request)
AWSStorageGatewayAsyncReturns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
describeChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the Amazon Resource Name (ARN) of the
iSCSI volume target.public Future<DescribeChapCredentialsResult> describeChapCredentialsAsync(DescribeChapCredentialsRequest request, AsyncHandler<DescribeChapCredentialsRequest,DescribeChapCredentialsResult> asyncHandler)
AWSStorageGatewayAsyncReturns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
describeChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeGatewayInformationResult> describeGatewayInformationAsync(DescribeGatewayInformationRequest request)
AWSStorageGatewayAsyncReturns 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.
describeGatewayInformationAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the id of the gateway.public Future<DescribeGatewayInformationResult> describeGatewayInformationAsync(DescribeGatewayInformationRequest request, AsyncHandler<DescribeGatewayInformationRequest,DescribeGatewayInformationResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeGatewayInformationAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeMaintenanceStartTimeResult> describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest request)
AWSStorageGatewayAsyncReturns 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.
describeMaintenanceStartTimeAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway.public Future<DescribeMaintenanceStartTimeResult> describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest request, AsyncHandler<DescribeMaintenanceStartTimeRequest,DescribeMaintenanceStartTimeResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeMaintenanceStartTimeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeSnapshotScheduleResult> describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest request)
AWSStorageGatewayAsyncDescribes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
describeSnapshotScheduleAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the
DescribeSnapshotScheduleInput$VolumeARN of the volume.public Future<DescribeSnapshotScheduleResult> describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest request, AsyncHandler<DescribeSnapshotScheduleRequest,DescribeSnapshotScheduleResult> asyncHandler)
AWSStorageGatewayAsyncDescribes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
describeSnapshotScheduleAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeStorediSCSIVolumesResult> describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest request)
AWSStorageGatewayAsyncReturns 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.
describeStorediSCSIVolumesAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing a list of
DescribeStorediSCSIVolumesInput$VolumeARNs.public Future<DescribeStorediSCSIVolumesResult> describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest request, AsyncHandler<DescribeStorediSCSIVolumesRequest,DescribeStorediSCSIVolumesResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeStorediSCSIVolumesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(DescribeTapeArchivesRequest request)
AWSStorageGatewayAsyncReturns 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.
describeTapeArchivesAsync in interface AWSStorageGatewayAsyncrequest - DescribeTapeArchivesInputpublic Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(DescribeTapeArchivesRequest request, AsyncHandler<DescribeTapeArchivesRequest,DescribeTapeArchivesResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeTapeArchivesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync()
describeTapeArchivesAsync in interface AWSStorageGatewayAsyncdescribeTapeArchivesAsync(DescribeTapeArchivesRequest)public Future<DescribeTapeArchivesResult> describeTapeArchivesAsync(AsyncHandler<DescribeTapeArchivesRequest,DescribeTapeArchivesResult> asyncHandler)
describeTapeArchivesAsync in interface AWSStorageGatewayAsyncdescribeTapeArchivesAsync(DescribeTapeArchivesRequest,
com.amazonaws.handlers.AsyncHandler)public Future<DescribeTapeRecoveryPointsResult> describeTapeRecoveryPointsAsync(DescribeTapeRecoveryPointsRequest request)
AWSStorageGatewayAsyncReturns 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.
describeTapeRecoveryPointsAsync in interface AWSStorageGatewayAsyncrequest - DescribeTapeRecoveryPointsInputpublic Future<DescribeTapeRecoveryPointsResult> describeTapeRecoveryPointsAsync(DescribeTapeRecoveryPointsRequest request, AsyncHandler<DescribeTapeRecoveryPointsRequest,DescribeTapeRecoveryPointsResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeTapeRecoveryPointsAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeTapesResult> describeTapesAsync(DescribeTapesRequest request)
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.
describeTapesAsync in interface AWSStorageGatewayAsyncrequest - DescribeTapesInputpublic Future<DescribeTapesResult> describeTapesAsync(DescribeTapesRequest request, AsyncHandler<DescribeTapesRequest,DescribeTapesResult> asyncHandler)
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.
describeTapesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeUploadBufferResult> describeUploadBufferAsync(DescribeUploadBufferRequest request)
AWSStorageGatewayAsyncReturns 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.
describeUploadBufferAsync in interface AWSStorageGatewayAsyncpublic Future<DescribeUploadBufferResult> describeUploadBufferAsync(DescribeUploadBufferRequest request, AsyncHandler<DescribeUploadBufferRequest,DescribeUploadBufferResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeUploadBufferAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<DescribeVTLDevicesResult> describeVTLDevicesAsync(DescribeVTLDevicesRequest request)
AWSStorageGatewayAsyncReturns 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.
describeVTLDevicesAsync in interface AWSStorageGatewayAsyncrequest - DescribeVTLDevicesInputpublic Future<DescribeVTLDevicesResult> describeVTLDevicesAsync(DescribeVTLDevicesRequest request, AsyncHandler<DescribeVTLDevicesRequest,DescribeVTLDevicesResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeVTLDevicesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DescribeWorkingStorageResult> describeWorkingStorageAsync(DescribeWorkingStorageRequest request)
AWSStorageGatewayAsyncReturns 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.
describeWorkingStorageAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway.public Future<DescribeWorkingStorageResult> describeWorkingStorageAsync(DescribeWorkingStorageRequest request, AsyncHandler<DescribeWorkingStorageRequest,DescribeWorkingStorageResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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.
describeWorkingStorageAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<DisableGatewayResult> disableGatewayAsync(DisableGatewayRequest request)
AWSStorageGatewayAsyncDisables 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.
disableGatewayAsync in interface AWSStorageGatewayAsyncrequest - DisableGatewayInputpublic Future<DisableGatewayResult> disableGatewayAsync(DisableGatewayRequest request, AsyncHandler<DisableGatewayRequest,DisableGatewayResult> asyncHandler)
AWSStorageGatewayAsyncDisables 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.
disableGatewayAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest request)
AWSStorageGatewayAsyncLists 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.
listGatewaysAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing zero or more of the following fields:
public Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest request, AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
AWSStorageGatewayAsyncLists 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.
listGatewaysAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListGatewaysResult> listGatewaysAsync()
listGatewaysAsync in interface AWSStorageGatewayAsynclistGatewaysAsync(ListGatewaysRequest)public Future<ListGatewaysResult> listGatewaysAsync(AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
listGatewaysAsync in interface AWSStorageGatewayAsynclistGatewaysAsync(ListGatewaysRequest,
com.amazonaws.handlers.AsyncHandler)public Future<ListLocalDisksResult> listLocalDisksAsync(ListLocalDisksRequest request)
AWSStorageGatewayAsyncReturns 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).
listLocalDisksAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway.public Future<ListLocalDisksResult> listLocalDisksAsync(ListLocalDisksRequest request, AsyncHandler<ListLocalDisksRequest,ListLocalDisksResult> asyncHandler)
AWSStorageGatewayAsyncReturns 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).
listLocalDisksAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSStorageGatewayAsyncLists the tags that have been added to the specified resource.
listTagsForResourceAsync in interface AWSStorageGatewayAsyncrequest - ListTagsForResourceInputpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSStorageGatewayAsyncLists the tags that have been added to the specified resource.
listTagsForResourceAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync()
listTagsForResourceAsync in interface AWSStorageGatewayAsynclistTagsForResourceAsync(ListTagsForResourceRequest)public Future<ListTagsForResourceResult> listTagsForResourceAsync(AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
listTagsForResourceAsync in interface AWSStorageGatewayAsynclistTagsForResourceAsync(ListTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler)public Future<ListTapesResult> listTapesAsync(ListTapesRequest request)
AWSStorageGatewayAsyncLists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a
maximum of up to 100 tapes. You can optionally specify the
Limit parameter in the body to limit the number of tapes in
the response. If the number of tapes returned in the response is
truncated, the response includes a Marker element that you
can use in your subsequent request to retrieve the next set of tapes.
listTapesAsync in interface AWSStorageGatewayAsyncrequest - A JSON object that contains one or more of the following
fields:
public Future<ListTapesResult> listTapesAsync(ListTapesRequest request, AsyncHandler<ListTapesRequest,ListTapesResult> asyncHandler)
AWSStorageGatewayAsyncLists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a
maximum of up to 100 tapes. You can optionally specify the
Limit parameter in the body to limit the number of tapes in
the response. If the number of tapes returned in the response is
truncated, the response includes a Marker element that you
can use in your subsequent request to retrieve the next set of tapes.
listTapesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListVolumeInitiatorsResult> listVolumeInitiatorsAsync(ListVolumeInitiatorsRequest request)
AWSStorageGatewayAsyncLists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
listVolumeInitiatorsAsync in interface AWSStorageGatewayAsyncrequest - ListVolumeInitiatorsInputpublic Future<ListVolumeInitiatorsResult> listVolumeInitiatorsAsync(ListVolumeInitiatorsRequest request, AsyncHandler<ListVolumeInitiatorsRequest,ListVolumeInitiatorsResult> asyncHandler)
AWSStorageGatewayAsyncLists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
listVolumeInitiatorsAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ListVolumeRecoveryPointsResult> listVolumeRecoveryPointsAsync(ListVolumeRecoveryPointsRequest request)
AWSStorageGatewayAsyncLists 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.
listVolumeRecoveryPointsAsync in interface AWSStorageGatewayAsyncpublic Future<ListVolumeRecoveryPointsResult> listVolumeRecoveryPointsAsync(ListVolumeRecoveryPointsRequest request, AsyncHandler<ListVolumeRecoveryPointsRequest,ListVolumeRecoveryPointsResult> asyncHandler)
AWSStorageGatewayAsyncLists 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.
listVolumeRecoveryPointsAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<ListVolumesResult> listVolumesAsync(ListVolumesRequest request)
AWSStorageGatewayAsyncLists 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.
listVolumesAsync in interface AWSStorageGatewayAsyncrequest - A JSON object that contains one or more of the following
fields:
public Future<ListVolumesResult> listVolumesAsync(ListVolumesRequest request, AsyncHandler<ListVolumesRequest,ListVolumesResult> asyncHandler)
AWSStorageGatewayAsyncLists 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.
listVolumesAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request)
AWSStorageGatewayAsyncRemoves one or more tags from the specified resource.
removeTagsFromResourceAsync in interface AWSStorageGatewayAsyncrequest - RemoveTagsFromResourceInputpublic Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
AWSStorageGatewayAsyncRemoves one or more tags from the specified resource.
removeTagsFromResourceAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync()
removeTagsFromResourceAsync in interface AWSStorageGatewayAsyncremoveTagsFromResourceAsync(RemoveTagsFromResourceRequest)public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
removeTagsFromResourceAsync in interface AWSStorageGatewayAsyncremoveTagsFromResourceAsync(RemoveTagsFromResourceRequest,
com.amazonaws.handlers.AsyncHandler)public Future<ResetCacheResult> resetCacheAsync(ResetCacheRequest request)
AWSStorageGatewayAsyncResets 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.
resetCacheAsync in interface AWSStorageGatewayAsyncpublic Future<ResetCacheResult> resetCacheAsync(ResetCacheRequest request, AsyncHandler<ResetCacheRequest,ResetCacheResult> asyncHandler)
AWSStorageGatewayAsyncResets 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.
resetCacheAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<RetrieveTapeArchiveResult> retrieveTapeArchiveAsync(RetrieveTapeArchiveRequest request)
AWSStorageGatewayAsyncRetrieves 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.
retrieveTapeArchiveAsync in interface AWSStorageGatewayAsyncrequest - RetrieveTapeArchiveInputpublic Future<RetrieveTapeArchiveResult> retrieveTapeArchiveAsync(RetrieveTapeArchiveRequest request, AsyncHandler<RetrieveTapeArchiveRequest,RetrieveTapeArchiveResult> asyncHandler)
AWSStorageGatewayAsyncRetrieves 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.
retrieveTapeArchiveAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<RetrieveTapeRecoveryPointResult> retrieveTapeRecoveryPointAsync(RetrieveTapeRecoveryPointRequest request)
AWSStorageGatewayAsyncRetrieves 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.
retrieveTapeRecoveryPointAsync in interface AWSStorageGatewayAsyncrequest - RetrieveTapeRecoveryPointInputpublic Future<RetrieveTapeRecoveryPointResult> retrieveTapeRecoveryPointAsync(RetrieveTapeRecoveryPointRequest request, AsyncHandler<RetrieveTapeRecoveryPointRequest,RetrieveTapeRecoveryPointResult> asyncHandler)
AWSStorageGatewayAsyncRetrieves 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.
retrieveTapeRecoveryPointAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<SetLocalConsolePasswordResult> setLocalConsolePasswordAsync(SetLocalConsolePasswordRequest request)
AWSStorageGatewayAsyncSets 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.
setLocalConsolePasswordAsync in interface AWSStorageGatewayAsyncrequest - SetLocalConsolePasswordInputpublic Future<SetLocalConsolePasswordResult> setLocalConsolePasswordAsync(SetLocalConsolePasswordRequest request, AsyncHandler<SetLocalConsolePasswordRequest,SetLocalConsolePasswordResult> asyncHandler)
AWSStorageGatewayAsyncSets 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.
setLocalConsolePasswordAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<ShutdownGatewayResult> shutdownGatewayAsync(ShutdownGatewayRequest request)
AWSStorageGatewayAsyncShuts 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.
shutdownGatewayAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway to shut down.public Future<ShutdownGatewayResult> shutdownGatewayAsync(ShutdownGatewayRequest request, AsyncHandler<ShutdownGatewayRequest,ShutdownGatewayResult> asyncHandler)
AWSStorageGatewayAsyncShuts 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.
shutdownGatewayAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<StartGatewayResult> startGatewayAsync(StartGatewayRequest request)
AWSStorageGatewayAsyncStarts 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.
startGatewayAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway to start.public Future<StartGatewayResult> startGatewayAsync(StartGatewayRequest request, AsyncHandler<StartGatewayRequest,StartGatewayResult> asyncHandler)
AWSStorageGatewayAsyncStarts 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.
startGatewayAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateBandwidthRateLimitResult> updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<UpdateBandwidthRateLimitResult> updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest request, AsyncHandler<UpdateBandwidthRateLimitRequest,UpdateBandwidthRateLimitResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateBandwidthRateLimitAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateChapCredentialsResult> updateChapCredentialsAsync(UpdateChapCredentialsRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<UpdateChapCredentialsResult> updateChapCredentialsAsync(UpdateChapCredentialsRequest request, AsyncHandler<UpdateChapCredentialsRequest,UpdateChapCredentialsResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateChapCredentialsAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateGatewayInformationAsync in interface AWSStorageGatewayAsyncpublic Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest request, AsyncHandler<UpdateGatewayInformationRequest,UpdateGatewayInformationResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateGatewayInformationAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.public Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest request)
AWSStorageGatewayAsyncUpdates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success
response immediately. However, it might take some time for the update to
complete. You can call DescribeGatewayInformation to verify the
gateway is in the STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
updateGatewaySoftwareNowAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the of the gateway to update.public Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest request, AsyncHandler<UpdateGatewaySoftwareNowRequest,UpdateGatewaySoftwareNowResult> asyncHandler)
AWSStorageGatewayAsyncUpdates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success
response immediately. However, it might take some time for the update to
complete. You can call DescribeGatewayInformation to verify the
gateway is in the STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
updateGatewaySoftwareNowAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateMaintenanceStartTimeResult> updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateMaintenanceStartTimeAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing the following fields:
public Future<UpdateMaintenanceStartTimeResult> updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest request, AsyncHandler<UpdateMaintenanceStartTimeRequest,UpdateMaintenanceStartTimeResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateMaintenanceStartTimeAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateSnapshotScheduleResult> updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateSnapshotScheduleAsync in interface AWSStorageGatewayAsyncrequest - A JSON object containing one or more of the following fields:
public Future<UpdateSnapshotScheduleResult> updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest request, AsyncHandler<UpdateSnapshotScheduleRequest,UpdateSnapshotScheduleResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateSnapshotScheduleAsync in interface AWSStorageGatewayAsyncrequest - 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.public Future<UpdateVTLDeviceTypeResult> updateVTLDeviceTypeAsync(UpdateVTLDeviceTypeRequest request)
AWSStorageGatewayAsyncUpdates 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.
updateVTLDeviceTypeAsync in interface AWSStorageGatewayAsyncpublic Future<UpdateVTLDeviceTypeResult> updateVTLDeviceTypeAsync(UpdateVTLDeviceTypeRequest request, AsyncHandler<UpdateVTLDeviceTypeRequest,UpdateVTLDeviceTypeResult> asyncHandler)
AWSStorageGatewayAsyncUpdates 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.
updateVTLDeviceTypeAsync in interface AWSStorageGatewayAsyncasyncHandler - 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.