public interface AWSStorageGateway
AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference :
| Modifier and Type | Method and Description |
|---|---|
ActivateGatewayResult |
activateGateway(ActivateGatewayRequest activateGatewayRequest)
This operation activates the gateway you previously deployed on your
host.
|
AddCacheResult |
addCache(AddCacheRequest addCacheRequest)
This operation configures one or more gateway local disks as cache for
a cached-volume gateway.
|
AddUploadBufferResult |
addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
This operation configures one or more gateway local disks as upload
buffer for a specified gateway.
|
AddWorkingStorageResult |
addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
This operation configures one or more gateway local disks as working
storage for a gateway.
|
CancelArchivalResult |
cancelArchival(CancelArchivalRequest cancelArchivalRequest)
Cancels archiving of a virtual tape to the Virtual Tape Shelf (VTS)
after archiving process is initiated.
|
CancelRetrievalResult |
cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the Virtual Tape Shelf (VTS)
to a gateway after the retrieval process is initiated.
|
CreateCachediSCSIVolumeResult |
createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest)
This operation creates a cached volume on a specified cached gateway.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
This operation initiates a snapshot of a volume.
|
CreateSnapshotFromVolumeRecoveryPointResult |
createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
This operation initiates a snapshot of a gateway from a volume
recovery point.
|
CreateStorediSCSIVolumeResult |
createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
This operation creates a volume on a specified gateway.
|
CreateTapesResult |
createTapes(CreateTapesRequest createTapesRequest)
Creates one or more virtual tapes.
|
DeleteBandwidthRateLimitResult |
deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
This operation deletes the bandwidth rate limits of a gateway.
|
DeleteChapCredentialsResult |
deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
This operation deletes Challenge-Handshake Authentication Protocol
(CHAP) credentials for a specified iSCSI target and initiator pair.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
This operation deletes a gateway.
|
DeleteSnapshotScheduleResult |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
This operation deletes a snapshot of a volume.
|
DeleteTapeResult |
deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape.
|
DeleteTapeArchiveResult |
deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the Virtual Tape Shelf (VTS).
|
DeleteVolumeResult |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
This operation delete the specified gateway volume that you previously
created using the CreateStorediSCSIVolume API.
|
DescribeBandwidthRateLimitResult |
describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
This operation returns the bandwidth rate limits of a gateway.
|
DescribeCacheResult |
describeCache(DescribeCacheRequest describeCacheRequest)
This operation returns information about the cache of a gateway.
|
DescribeCachediSCSIVolumesResult |
describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest)
This operation returns a description of the gateway volumes specified
in the request.
|
DescribeChapCredentialsResult |
describeChapCredentials(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.
|
DescribeGatewayInformationResult |
describeGatewayInformation(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).
|
DescribeMaintenanceStartTimeResult |
describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
This operation returns your gateway's weekly maintenance start time
including the day and time of the week.
|
DescribeSnapshotScheduleResult |
describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
This operation describes the snapshot schedule for the specified
gateway volume.
|
DescribeStorediSCSIVolumesResult |
describeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
This operation returns description of the gateway volumes specified in
the request.
|
DescribeTapeArchivesResult |
describeTapeArchives()
Returns a description of specified virtual tapes in the Virtual Tape
Shelf (VTS).
|
DescribeTapeArchivesResult |
describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the Virtual Tape
Shelf (VTS).
|
DescribeTapeRecoveryPointsResult |
describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for
the specified Gateway-Virtual Tape Library.
|
DescribeTapesResult |
describeTapes(DescribeTapesRequest describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of
virtual tapes.
|
DescribeUploadBufferResult |
describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
This operation returns information about the upload buffer of a
gateway.
|
DescribeVTLDevicesResult |
describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest)
Returns a description of Virtual Tape Library (VTL) devices for the
gateway specified in the request.
|
DescribeWorkingStorageResult |
describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
This operation returns information about the working storage of a
gateway.
|
DisableGatewayResult |
disableGateway(DisableGatewayRequest disableGatewayRequest)
Disables a gateway when the gateway is no longer functioning.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for
debugging issues where a service isn't acting as expected.
|
ListGatewaysResult |
listGateways()
This operation lists gateways owned by an AWS account in a region
specified in the request.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest listGatewaysRequest)
This operation lists gateways owned by an AWS account in a region
specified in the request.
|
ListLocalDisksResult |
listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
This operation returns a list of the local disks of a gateway.
|
ListVolumeRecoveryPointsResult |
listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
This operation lists the recovery points for a specified gateway.
|
ListVolumesResult |
listVolumes(ListVolumesRequest listVolumesRequest)
This operation lists the iSCSI stored volumes of a gateway.
|
RetrieveTapeArchiveResult |
retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the Virtual Tape Shelf (VTS)
to a Gateway-Virtual Tape Library.
|
RetrieveTapeRecoveryPointResult |
retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://storagegateway.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
ShutdownGatewayResult |
shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
This operation shuts down a gateway.
|
StartGatewayResult |
startGateway(StartGatewayRequest startGatewayRequest)
This operation starts a gateway that you previously shut down (see
ShutdownGateway).
|
UpdateBandwidthRateLimitResult |
updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
This operation updates the bandwidth rate limits of a gateway.
|
UpdateChapCredentialsResult |
updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
This operation updates the Challenge-Handshake Authentication Protocol
(CHAP) credentials for a specified iSCSI target.
|
UpdateGatewayInformationResult |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
This operation updates a gateway's metadata, which includes the
gateway's name and time zone.
|
UpdateGatewaySoftwareNowResult |
updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
This operation updates the gateway virtual machine (VM) software.
|
UpdateMaintenanceStartTimeResult |
updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
This operation updates a gateway's weekly maintenance start time
information, including day and time of the week.
|
UpdateSnapshotScheduleResult |
updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
This operation updates a snapshot schedule configured for a gateway
volume.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://storagegateway.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://storagegateway.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)DeleteSnapshotScheduleResult deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) throws AmazonServiceException, AmazonClientException
This operation deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or
ad-hoc basis. This API 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).
NOTE: To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
deleteSnapshotScheduleRequest - Container for the necessary
parameters to execute the DeleteSnapshotSchedule service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeMaintenanceStartTimeResult describeMaintenanceStartTime(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.
describeMaintenanceStartTimeRequest - Container for the necessary
parameters to execute the DescribeMaintenanceStartTime service method
on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CreateStorediSCSIVolumeResult createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest) throws AmazonServiceException, AmazonClientException
This operation creates a volume on a specified gateway. This operation is supported only for the gateway-cached 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.
createStorediSCSIVolumeRequest - Container for the necessary
parameters to execute the CreateStorediSCSIVolume service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateGatewaySoftwareNowResult updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) throws AmazonServiceException, AmazonClientException
This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
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.
IMPORTANT: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.
updateGatewaySoftwareNowRequest - Container for the necessary
parameters to execute the UpdateGatewaySoftwareNow service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CreateSnapshotResult createSnapshot(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 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.
NOTE:To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .
createSnapshotRequest - Container for the necessary parameters to
execute the CreateSnapshot service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.AddWorkingStorageResult addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest) throws AmazonServiceException, AmazonClientException
This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture.
NOTE: 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.
addWorkingStorageRequest - Container for the necessary parameters
to execute the AddWorkingStorage service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CancelRetrievalResult cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest) throws AmazonServiceException, AmazonClientException
Cancels retrieval of a virtual tape from the Virtual Tape Shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the Virtual Tape Shelf.
cancelRetrievalRequest - Container for the necessary parameters
to execute the CancelRetrieval service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeBandwidthRateLimitResult describeBandwidthRateLimit(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.
describeBandwidthRateLimitRequest - Container for the necessary
parameters to execute the DescribeBandwidthRateLimit service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeTapesResult describeTapes(DescribeTapesRequest describeTapesRequest) throws AmazonServiceException, AmazonClientException
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.
describeTapesRequest - Container for the necessary parameters to
execute the DescribeTapes service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.RetrieveTapeRecoveryPointResult retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest) throws AmazonServiceException, AmazonClientException
Retrieves the recovery point for the specified virtual tape.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
NOTE: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-Virtual Tape Library. There is no charge for retrieving recovery points.
retrieveTapeRecoveryPointRequest - Container for the necessary
parameters to execute the RetrieveTapeRecoveryPoint service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateChapCredentialsResult updateChapCredentials(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.
IMPORTANT: When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
updateChapCredentialsRequest - Container for the necessary
parameters to execute the UpdateChapCredentials service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CreateTapesResult createTapes(CreateTapesRequest createTapesRequest) throws AmazonServiceException, AmazonClientException
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
NOTE: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.
createTapesRequest - Container for the necessary parameters to
execute the CreateTapes service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeUploadBufferResult describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest) throws AmazonServiceException, AmazonClientException
This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
describeUploadBufferRequest - Container for the necessary
parameters to execute the DescribeUploadBuffer service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteChapCredentialsResult deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest) throws AmazonServiceException, AmazonClientException
This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
deleteChapCredentialsRequest - Container for the necessary
parameters to execute the DeleteChapCredentials service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.AddCacheResult addCache(AddCacheRequest addCacheRequest) throws AmazonServiceException, AmazonClientException
This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts ).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
addCacheRequest - Container for the necessary parameters to
execute the AddCache service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeGatewayInformationResult describeGatewayInformation(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.
describeGatewayInformationRequest - Container for the necessary
parameters to execute the DescribeGatewayInformation service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ActivateGatewayResult activateGateway(ActivateGatewayRequest activateGatewayRequest) throws AmazonServiceException, AmazonClientException
This operation activates the gateway you previously deployed on your host. For more information, see Downloading and Deploying AWS Storage Gateway VM . 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 (see UpdateGatewayInformation).
NOTE:You must power on the gateway VM before you can activate your gateway.
activateGatewayRequest - Container for the necessary parameters
to execute the ActivateGateway service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeTapeArchivesResult describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest) throws AmazonServiceException, AmazonClientException
Returns a description of specified virtual tapes in the Virtual Tape Shelf (VTS).
If a specific TapeARN is not specified, AWS Storage
Gateway returns a description all virtual tapes found in the Virtual
Tape Shelf (VTS) associated with your account.
describeTapeArchivesRequest - Container for the necessary
parameters to execute the DescribeTapeArchives service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateGatewayInformationResult updateGatewayInformation(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.
updateGatewayInformationRequest - Container for the necessary
parameters to execute the UpdateGatewayInformation service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ListLocalDisksResult listLocalDisks(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.
listLocalDisksRequest - Container for the necessary parameters to
execute the ListLocalDisks service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteTapeArchiveResult deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified virtual tape from the Virtual Tape Shelf (VTS).
deleteTapeArchiveRequest - Container for the necessary parameters
to execute the DeleteTapeArchive service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeCacheResult describeCache(DescribeCacheRequest describeCacheRequest) throws AmazonServiceException, AmazonClientException
This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
describeCacheRequest - Container for the necessary parameters to
execute the DescribeCache service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateBandwidthRateLimitResult updateBandwidthRateLimit(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.
updateBandwidthRateLimitRequest - Container for the necessary
parameters to execute the UpdateBandwidthRateLimit service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DisableGatewayResult disableGateway(DisableGatewayRequest disableGatewayRequest) throws AmazonServiceException, AmazonClientException
Disables a gateway when the gateway is no longer functioning. For examples, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a Gateway-Virtual Tape Library that is not reachable or not functioning.
IMPORTANT:Once a gateway is disabled it cannot be enabled.
disableGatewayRequest - Container for the necessary parameters to
execute the DisableGateway service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeWorkingStorageResult describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest) throws AmazonServiceException, AmazonClientException
This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture.
NOTE: 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.
describeWorkingStorageRequest - Container for the necessary
parameters to execute the DescribeWorkingStorage service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateMaintenanceStartTimeResult updateMaintenanceStartTime(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.
updateMaintenanceStartTimeRequest - Container for the necessary
parameters to execute the UpdateMaintenanceStartTime service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteTapeResult deleteTape(DeleteTapeRequest deleteTapeRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified virtual tape.
deleteTapeRequest - Container for the necessary parameters to
execute the DeleteTape service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.StartGatewayResult startGateway(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.
startGatewayRequest - Container for the necessary parameters to
execute the StartGateway service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeChapCredentialsResult describeChapCredentials(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.
describeChapCredentialsRequest - Container for the necessary
parameters to execute the DescribeChapCredentials service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeSnapshotScheduleResult describeSnapshotSchedule(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.
describeSnapshotScheduleRequest - Container for the necessary
parameters to execute the DescribeSnapshotSchedule service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteVolumeResult deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws AmazonServiceException, AmazonClientException
This operation delete the specified gateway volume that you previously created using the 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.
deleteVolumeRequest - Container for the necessary parameters to
execute the DeleteVolume service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CreateSnapshotFromVolumeRecoveryPointResult createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest) throws AmazonServiceException, AmazonClientException
This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).
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.
NOTE: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
createSnapshotFromVolumeRecoveryPointRequest - Container for the
necessary parameters to execute the
CreateSnapshotFromVolumeRecoveryPoint service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteGatewayResult deleteGateway(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.
IMPORTANT: 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.
deleteGatewayRequest - Container for the necessary parameters to
execute the DeleteGateway service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CreateCachediSCSIVolumeResult createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest) throws AmazonServiceException, AmazonClientException
This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
NOTE: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.
createCachediSCSIVolumeRequest - Container for the necessary
parameters to execute the CreateCachediSCSIVolume service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ShutdownGatewayResult shutdownGateway(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.
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.
shutdownGatewayRequest - Container for the necessary parameters
to execute the ShutdownGateway service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DeleteBandwidthRateLimitResult deleteBandwidthRateLimit(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.
deleteBandwidthRateLimitRequest - Container for the necessary
parameters to execute the DeleteBandwidthRateLimit service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ListVolumesResult listVolumes(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.
listVolumesRequest - Container for the necessary parameters to
execute the ListVolumes service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeTapeRecoveryPointsResult describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of virtual tape recovery points that are available for the specified Gateway-Virtual Tape Library.
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.
describeTapeRecoveryPointsRequest - Container for the necessary
parameters to execute the DescribeTapeRecoveryPoints service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.UpdateSnapshotScheduleResult updateSnapshotSchedule(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 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.
updateSnapshotScheduleRequest - Container for the necessary
parameters to execute the UpdateSnapshotSchedule service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ListGatewaysResult listGateways(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.
listGatewaysRequest - Container for the necessary parameters to
execute the ListGateways service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.AddUploadBufferResult addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest) throws AmazonServiceException, AmazonClientException
This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
addUploadBufferRequest - Container for the necessary parameters
to execute the AddUploadBuffer service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeCachediSCSIVolumesResult describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest) throws AmazonServiceException, AmazonClientException
This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
describeCachediSCSIVolumesRequest - Container for the necessary
parameters to execute the DescribeCachediSCSIVolumes service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeStorediSCSIVolumesResult describeStorediSCSIVolumes(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.
describeStorediSCSIVolumesRequest - Container for the necessary
parameters to execute the DescribeStorediSCSIVolumes service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ListVolumeRecoveryPointsResult listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest) throws AmazonServiceException, AmazonClientException
This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
listVolumeRecoveryPointsRequest - Container for the necessary
parameters to execute the ListVolumeRecoveryPoints service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeVTLDevicesResult describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest) throws AmazonServiceException, AmazonClientException
Returns a description of Virtual Tape Library (VTL) devices for the gateway specified in the request. In the response, AWS Storage Gateway returns Virtual Tape Library device information.
The list of Virtual Tape Library devices in the request must be from one gateway.
describeVTLDevicesRequest - Container for the necessary
parameters to execute the DescribeVTLDevices service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.RetrieveTapeArchiveResult retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest) throws AmazonServiceException, AmazonClientException
Retrieves an archived virtual tape from the Virtual Tape Shelf (VTS) to a Gateway-Virtual Tape Library. Virtual tapes archived in the Virtual Tape Shelf (VTS) are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway though it also listed in 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.
retrieveTapeArchiveRequest - Container for the necessary
parameters to execute the RetrieveTapeArchive service method on
AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.CancelArchivalResult cancelArchival(CancelArchivalRequest cancelArchivalRequest) throws AmazonServiceException, AmazonClientException
Cancels archiving of a virtual tape to the Virtual Tape Shelf (VTS) after archiving process is initiated.
cancelArchivalRequest - Container for the necessary parameters to
execute the CancelArchival service method on AWSStorageGateway.InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.DescribeTapeArchivesResult describeTapeArchives() throws AmazonServiceException, AmazonClientException
Returns a description of specified virtual tapes in the Virtual Tape Shelf (VTS).
If a specific TapeARN is not specified, AWS Storage
Gateway returns a description all virtual tapes found in the Virtual
Tape Shelf (VTS) associated with your account.
InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.ListGatewaysResult listGateways() 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.
InternalServerErrorExceptionInvalidGatewayRequestExceptionAmazonClientException - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2016. All rights reserved.