com.amazonaws.services.storagegateway
Class AWSStorageGatewayAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.storagegateway.AWSStorageGatewayClient
          com.amazonaws.services.storagegateway.AWSStorageGatewayAsyncClient

All Implemented Interfaces:

AWSStorageGateway, AWSStorageGatewayAsync

public class AWSStorageGatewayAsyncClient
extends AWSStorageGatewayClient
implements AWSStorageGatewayAsync

Client for accessing AWSStorageGateway. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed. AWS Storage Gateway Service

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

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

• AWS Storage Gateway Required Request Headers : Describes the required headers that you must send with every POST request to AWS Storage Gateway.
• Signing Requests : AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
• Error Responses : Provides reference information about AWS Storage Gateway errors.
• Operations in AWS Storage Gateway : Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
• AWS Storage Gateway Regions and Endpoints : Provides a list of each of the regions and endpoints available for use with AWS Storage Gateway.

Constructor Summary

AWSStorageGatewayAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway.

AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials.

AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials, executor service, and client configuration options.

AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials and executor service.

AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider.

AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider, executor service, and client configuration options.

AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider and executor service.

AWSStorageGatewayAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWSStorageGateway.

Method Summary

Future<ActivateGatewayResult>	activateGatewayAsync(ActivateGatewayRequest activateGatewayRequest) This operation activates the gateway you previously deployed on your VMware host.
Future<AddWorkingStorageResult>	addWorkingStorageAsync(AddWorkingStorageRequest addWorkingStorageRequest) This operation configures one or more gateway local disks as working storage.
Future<CreateSnapshotResult>	createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest) This operation initiates a snapshot of a volume.
Future<CreateStorediSCSIVolumeResult>	createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest) This operation creates a volume on a specified gateway.
Future<DeleteBandwidthRateLimitResult>	deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest) This operation deletes the bandwidth rate limits of a gateway.
Future<DeleteChapCredentialsResult>	deleteChapCredentialsAsync(DeleteChapCredentialsRequest deleteChapCredentialsRequest) This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
Future<DeleteGatewayResult>	deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest) This operation deletes a gateway.
Future<DeleteVolumeResult>	deleteVolumeAsync(DeleteVolumeRequest deleteVolumeRequest) This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API.
Future<DescribeBandwidthRateLimitResult>	describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest) This operation returns the bandwidth rate limits of a gateway.
Future<DescribeChapCredentialsResult>	describeChapCredentialsAsync(DescribeChapCredentialsRequest describeChapCredentialsRequest) This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
Future<DescribeGatewayInformationResult>	describeGatewayInformationAsync(DescribeGatewayInformationRequest describeGatewayInformationRequest) This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
Future<DescribeMaintenanceStartTimeResult>	describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest) This operation returns your gateway's weekly maintenance start time including the day and time of the week.
Future<DescribeSnapshotScheduleResult>	describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest) This operation describes the snapshot schedule for the specified gateway volume.
Future<DescribeStorediSCSIVolumesResult>	describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest) This operation returns description of the gateway volumes specified in the request.
Future<DescribeWorkingStorageResult>	describeWorkingStorageAsync(DescribeWorkingStorageRequest describeWorkingStorageRequest) This operation returns information about the working storage of a gateway.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<ListGatewaysResult>	listGatewaysAsync(ListGatewaysRequest listGatewaysRequest) This operation lists gateways owned by an AWS account in a region specified in the request.
Future<ListLocalDisksResult>	listLocalDisksAsync(ListLocalDisksRequest listLocalDisksRequest) This operation returns a list of the local disks of a gateway.
Future<ListVolumesResult>	listVolumesAsync(ListVolumesRequest listVolumesRequest) This operation lists the iSCSI stored volumes of a gateway.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<ShutdownGatewayResult>	shutdownGatewayAsync(ShutdownGatewayRequest shutdownGatewayRequest) This operation shuts down a gateway.
Future<StartGatewayResult>	startGatewayAsync(StartGatewayRequest startGatewayRequest) This operation starts a gateway that you previously shut down (see ShutdownGateway).
Future<UpdateBandwidthRateLimitResult>	updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest) This operation updates the bandwidth rate limits of a gateway.
Future<UpdateChapCredentialsResult>	updateChapCredentialsAsync(UpdateChapCredentialsRequest updateChapCredentialsRequest) This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
Future<UpdateGatewayInformationResult>	updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest) This operation updates a gateway's metadata, which includes the gateway's name and time zone.
Future<UpdateGatewaySoftwareNowResult>	updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) This operation updates the gateway virtual machine (VM) software.
Future<UpdateMaintenanceStartTimeResult>	updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest) This operation updates a gateway's weekly maintenance start time information, including day and time of the week.
Future<UpdateSnapshotScheduleResult>	updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest) This operation updates a snapshot schedule configured for a gateway volume.

Methods inherited from class com.amazonaws.services.storagegateway.AWSStorageGatewayClient

activateGateway, addWorkingStorage, createSnapshot, createStorediSCSIVolume, deleteBandwidthRateLimit, deleteChapCredentials, deleteGateway, deleteVolume, describeBandwidthRateLimit, describeChapCredentials, describeGatewayInformation, describeMaintenanceStartTime, describeSnapshotSchedule, describeStorediSCSIVolumes, describeWorkingStorage, getCachedResponseMetadata, listGateways, listGateways, listLocalDisks, listVolumes, setEndpoint, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.storagegateway.AWSStorageGateway

activateGateway, addWorkingStorage, createSnapshot, createStorediSCSIVolume, deleteBandwidthRateLimit, deleteChapCredentials, deleteGateway, deleteVolume, describeBandwidthRateLimit, describeChapCredentials, describeGatewayInformation, describeMaintenanceStartTime, describeSnapshotSchedule, describeStorediSCSIVolumes, describeWorkingStorage, getCachedResponseMetadata, listGateways, listGateways, listLocalDisks, listVolumes, setEndpoint, shutdownGateway, startGateway, updateBandwidthRateLimit, updateChapCredentials, updateGatewayInformation, updateGatewaySoftwareNow, updateMaintenanceStartTime, updateSnapshotSchedule

Constructor Detail

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient()

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSStorageGateway (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials,
                                    ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration,
                                    ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSStorageGatewayAsyncClient

public AWSStorageGatewayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSStorageGateway using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() prior to calling this method.

Specified by:

shutdown in interface AWSStorageGateway

Overrides:

shutdown in class AmazonWebServiceClient

describeBandwidthRateLimitAsync

public Future<DescribeBandwidthRateLimitResult> describeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

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

Specified by:

describeBandwidthRateLimitAsync in interface AWSStorageGatewayAsync

Parameters:

describeBandwidthRateLimitRequest - Container for the necessary parameters to execute the DescribeBandwidthRateLimit operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeBandwidthRateLimit service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

shutdownGatewayAsync

public Future<ShutdownGatewayResult> shutdownGatewayAsync(ShutdownGatewayRequest shutdownGatewayRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

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

NOTE: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.

NOTE: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.

Specified by:

shutdownGatewayAsync in interface AWSStorageGatewayAsync

Parameters:

shutdownGatewayRequest - Container for the necessary parameters to execute the ShutdownGateway operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the ShutdownGateway service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

createSnapshotAsync

public Future<CreateSnapshotResult> createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

This operation initiates a snapshot of a volume.

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

In the CreateSnapshot request you identify the volume by providing it's 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.

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

Specified by:

createSnapshotAsync in interface AWSStorageGatewayAsync

Parameters:

createSnapshotRequest - Container for the necessary parameters to execute the CreateSnapshot operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the CreateSnapshot service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

deleteVolumeAsync

public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest deleteVolumeRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API. The gateway 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 (EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .

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

Specified by:

deleteVolumeAsync in interface AWSStorageGatewayAsync

Parameters:

deleteVolumeRequest - Container for the necessary parameters to execute the DeleteVolume operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DeleteVolume service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateMaintenanceStartTimeAsync

public Future<UpdateMaintenanceStartTimeResult> updateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

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

Specified by:

updateMaintenanceStartTimeAsync in interface AWSStorageGatewayAsync

Parameters:

updateMaintenanceStartTimeRequest - Container for the necessary parameters to execute the UpdateMaintenanceStartTime operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateMaintenanceStartTime service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeGatewayInformationAsync

public Future<DescribeGatewayInformationResult> describeGatewayInformationAsync(DescribeGatewayInformationRequest describeGatewayInformationRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Specified by:

describeGatewayInformationAsync in interface AWSStorageGatewayAsync

Parameters:

describeGatewayInformationRequest - Container for the necessary parameters to execute the DescribeGatewayInformation operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeGatewayInformation service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

createStorediSCSIVolumeAsync

public Future<CreateStorediSCSIVolumeResult> createStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
                                                                   throws AmazonServiceException,
                                                                          AmazonClientException

This operation creates a volume on a specified gateway. The size of the volume 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 ARN, size and the iSCSI target ARN that initiators can use to connect to the volume target.

Specified by:

createStorediSCSIVolumeAsync in interface AWSStorageGatewayAsync

Parameters:

createStorediSCSIVolumeRequest - Container for the necessary parameters to execute the CreateStorediSCSIVolume operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the CreateStorediSCSIVolume service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateChapCredentialsAsync

public Future<UpdateChapCredentialsResult> updateChapCredentialsAsync(UpdateChapCredentialsRequest updateChapCredentialsRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

Specified by:

updateChapCredentialsAsync in interface AWSStorageGatewayAsync

Parameters:

updateChapCredentialsRequest - Container for the necessary parameters to execute the UpdateChapCredentials operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateChapCredentials service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

startGatewayAsync

public Future<StartGatewayResult> startGatewayAsync(StartGatewayRequest startGatewayRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

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

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

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

Specified by:

startGatewayAsync in interface AWSStorageGatewayAsync

Parameters:

startGatewayRequest - Container for the necessary parameters to execute the StartGateway operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the StartGateway service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

deleteBandwidthRateLimitAsync

public Future<DeleteBandwidthRateLimitResult> deleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

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

Specified by:

deleteBandwidthRateLimitAsync in interface AWSStorageGatewayAsync

Parameters:

deleteBandwidthRateLimitRequest - Container for the necessary parameters to execute the DeleteBandwidthRateLimit operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DeleteBandwidthRateLimit service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateSnapshotScheduleAsync

public Future<UpdateSnapshotScheduleResult> updateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

This operation updates a snapshot schedule configured for a gateway volume.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the shapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Specified by:

updateSnapshotScheduleAsync in interface AWSStorageGatewayAsync

Parameters:

updateSnapshotScheduleRequest - Container for the necessary parameters to execute the UpdateSnapshotSchedule operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateSnapshotSchedule service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeMaintenanceStartTimeAsync

public Future<DescribeMaintenanceStartTimeResult> describeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

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

Specified by:

describeMaintenanceStartTimeAsync in interface AWSStorageGatewayAsync

Parameters:

describeMaintenanceStartTimeRequest - Container for the necessary parameters to execute the DescribeMaintenanceStartTime operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeMaintenanceStartTime service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeSnapshotScheduleAsync

public Future<DescribeSnapshotScheduleResult> describeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.

Specified by:

describeSnapshotScheduleAsync in interface AWSStorageGatewayAsync

Parameters:

describeSnapshotScheduleRequest - Container for the necessary parameters to execute the DescribeSnapshotSchedule operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeSnapshotSchedule service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateBandwidthRateLimitAsync

public Future<UpdateBandwidthRateLimitResult> updateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

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

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

Specified by:

updateBandwidthRateLimitAsync in interface AWSStorageGatewayAsync

Parameters:

updateBandwidthRateLimitRequest - Container for the necessary parameters to execute the UpdateBandwidthRateLimit operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateBandwidthRateLimit service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

deleteChapCredentialsAsync

public Future<DeleteChapCredentialsResult> deleteChapCredentialsAsync(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Specified by:

deleteChapCredentialsAsync in interface AWSStorageGatewayAsync

Parameters:

deleteChapCredentialsRequest - Container for the necessary parameters to execute the DeleteChapCredentials operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DeleteChapCredentials service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeStorediSCSIVolumesAsync

public Future<DescribeStorediSCSIVolumesResult> describeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

This operation returns description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.

Specified by:

describeStorediSCSIVolumesAsync in interface AWSStorageGatewayAsync

Parameters:

describeStorediSCSIVolumesRequest - Container for the necessary parameters to execute the DescribeStorediSCSIVolumes operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeStorediSCSIVolumes service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateGatewayInformationAsync

public Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

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

Specified by:

updateGatewayInformationAsync in interface AWSStorageGatewayAsync

Parameters:

updateGatewayInformationRequest - Container for the necessary parameters to execute the UpdateGatewayInformation operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateGatewayInformation service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

deleteGatewayAsync

public Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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

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

Specified by:

deleteGatewayAsync in interface AWSStorageGatewayAsync

Parameters:

deleteGatewayRequest - Container for the necessary parameters to execute the DeleteGateway operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DeleteGateway service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

listVolumesAsync

public Future<ListVolumesResult> listVolumesAsync(ListVolumesRequest listVolumesRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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

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

Specified by:

listVolumesAsync in interface AWSStorageGatewayAsync

Parameters:

listVolumesRequest - Container for the necessary parameters to execute the ListVolumes operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the ListVolumes service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

listLocalDisksAsync

public Future<ListLocalDisksResult> listLocalDisksAsync(ListLocalDisksRequest listLocalDisksRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

This operation returns a list of the local disks of a gateway. 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 all disks, specifying which are configured as working storage, stored volume or not configured at all.

Specified by:

listLocalDisksAsync in interface AWSStorageGatewayAsync

Parameters:

listLocalDisksRequest - Container for the necessary parameters to execute the ListLocalDisks operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the ListLocalDisks service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeChapCredentialsAsync

public Future<DescribeChapCredentialsResult> describeChapCredentialsAsync(DescribeChapCredentialsRequest describeChapCredentialsRequest)
                                                                   throws AmazonServiceException,
                                                                          AmazonClientException

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

Specified by:

describeChapCredentialsAsync in interface AWSStorageGatewayAsync

Parameters:

describeChapCredentialsRequest - Container for the necessary parameters to execute the DescribeChapCredentials operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeChapCredentials service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

updateGatewaySoftwareNowAsync

public Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update. Before initiating this update, make sure there is no traffic to the gateway.

Before sending this request, you should make sure all your applications have finished writing to your gateway's storage volumes in order to avoid data loss. During the update, applications cannot use the gateway's storage volumes.

NOTE: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.

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

Specified by:

updateGatewaySoftwareNowAsync in interface AWSStorageGatewayAsync

Parameters:

updateGatewaySoftwareNowRequest - Container for the necessary parameters to execute the UpdateGatewaySoftwareNow operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the UpdateGatewaySoftwareNow service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

listGatewaysAsync

public Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest listGatewaysRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

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

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

Specified by:

listGatewaysAsync in interface AWSStorageGatewayAsync

Parameters:

listGatewaysRequest - Container for the necessary parameters to execute the ListGateways operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the ListGateways service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

describeWorkingStorageAsync

public Future<DescribeWorkingStorageResult> describeWorkingStorageAsync(DescribeWorkingStorageRequest describeWorkingStorageRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

This operation returns information about the working storage of a gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

Specified by:

describeWorkingStorageAsync in interface AWSStorageGatewayAsync

Parameters:

describeWorkingStorageRequest - Container for the necessary parameters to execute the DescribeWorkingStorage operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the DescribeWorkingStorage service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

addWorkingStorageAsync

public Future<AddWorkingStorageResult> addWorkingStorageAsync(AddWorkingStorageRequest addWorkingStorageRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

This operation configures one or more gateway local disks as working storage.

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

Specified by:

addWorkingStorageAsync in interface AWSStorageGatewayAsync

Parameters:

addWorkingStorageRequest - Container for the necessary parameters to execute the AddWorkingStorage operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the AddWorkingStorage service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.

activateGatewayAsync

public Future<ActivateGatewayResult> activateGatewayAsync(ActivateGatewayRequest activateGatewayRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

This operation activates the gateway you previously deployed on your VMware host. For more information, see DownloadAndDeploy. In the activation process you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots and the gateway schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account.

NOTE:You must power on the gateway VM before you can activate your gateway.

Specified by:

activateGatewayAsync in interface AWSStorageGatewayAsync

Parameters:

activateGatewayRequest - Container for the necessary parameters to execute the ActivateGateway operation on AWSStorageGateway.

Returns:

A Java Future object containing the response from the ActivateGateway service method, as returned by AWSStorageGateway.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.