AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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:
Namespace: Amazon.StorageGateway
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonStorageGateway IDisposable
The IAmazonStorageGateway type exposes the following members
Name | Description | |
---|---|---|
![]() |
ActivateGateway(ActivateGatewayRequest) |
This operation activates the gateway you previously deployed on your host. For more
information, see
Activate the AWS Storage Gateway. In the activation process, you specify information
such as the region you want to use for storing snapshots, the time zone for scheduled
snapshots the gateway snapshot schedule window, an activation key, and a name for
your gateway. The activation process also associates your gateway with your account;
for more information, see UpdateGatewayInformation.
|
![]() |
ActivateGatewayAsync(ActivateGatewayRequest, CancellationToken) | Initiates the asynchronous execution of the ActivateGateway operation. |
![]() |
AddCache(AddCacheRequest) |
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. |
![]() |
AddCacheAsync(AddCacheRequest, CancellationToken) | Initiates the asynchronous execution of the AddCache operation. |
![]() |
AddTagsToResource(AddTagsToResourceRequest) |
This operation adds one or more tags to the specified resource. You use tags to add
metadata to resources, which you can use to categorize these resources. For example,
you can categorize resources by purpose, owner, environment, or team. Each tag consists
of a key and a value, which you define. You can add tags to the following AWS Storage
Gateway resources:
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. |
![]() |
AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken) | Initiates the asynchronous execution of the AddTagsToResource operation. |
![]() |
AddUploadBuffer(AddUploadBufferRequest) |
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. |
![]() |
AddUploadBufferAsync(AddUploadBufferRequest, CancellationToken) | Initiates the asynchronous execution of the AddUploadBuffer operation. |
![]() |
AddWorkingStorage(AddWorkingStorageRequest) |
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.
This operation is deprecated method in cached-volumes API version (20120630). Use
AddUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. |
![]() |
AddWorkingStorageAsync(AddWorkingStorageRequest, CancellationToken) | Initiates the asynchronous execution of the AddWorkingStorage operation. |
![]() |
CancelArchival(CancelArchivalRequest) | Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. |
![]() |
CancelArchivalAsync(CancelArchivalRequest, CancellationToken) | Initiates the asynchronous execution of the CancelArchival operation. |
![]() |
CancelRetrieval(CancelRetrievalRequest) | Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. |
![]() |
CancelRetrievalAsync(CancelRetrievalRequest, CancellationToken) | Initiates the asynchronous execution of the CancelRetrieval operation. |
![]() |
CreateCachediSCSIVolume(CreateCachediSCSIVolumeRequest) |
This operation creates a cached volume on a specified cached gateway. This operation
is supported only for the gateway-cached volume architecture.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. |
![]() |
CreateCachediSCSIVolumeAsync(CreateCachediSCSIVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCachediSCSIVolume operation. |
![]() |
CreateSnapshot(CreateSnapshotRequest) |
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. |
![]() |
CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the CreateSnapshot operation. |
![]() |
CreateSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest) |
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 To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference. |
![]() |
CreateSnapshotFromVolumeRecoveryPointAsync(CreateSnapshotFromVolumeRecoveryPointRequest, CancellationToken) | Initiates the asynchronous execution of the CreateSnapshotFromVolumeRecoveryPoint operation. |
![]() |
CreateStorediSCSIVolume(CreateStorediSCSIVolumeRequest) |
This operation creates a volume on a specified gateway. This operation is supported
only for the gateway-stored volume architecture.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. |
![]() |
CreateStorediSCSIVolumeAsync(CreateStorediSCSIVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the CreateStorediSCSIVolume operation. |
![]() |
CreateTapes(CreateTapesRequest) |
Creates one or more virtual tapes. You write data to the virtual tapes and then archive
the tapes.
|
![]() |
CreateTapesAsync(CreateTapesRequest, CancellationToken) | Initiates the asynchronous execution of the CreateTapes operation. |
![]() |
CreateTapeWithBarcode(CreateTapeWithBarcodeRequest) |
Creates a virtual tape by using your own barcode. You write data to the virtual tape
and then archive the tape.
|
![]() |
CreateTapeWithBarcodeAsync(CreateTapeWithBarcodeRequest, CancellationToken) | Initiates the asynchronous execution of the CreateTapeWithBarcode operation. |
![]() |
DeleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest) | 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. |
![]() |
DeleteBandwidthRateLimitAsync(DeleteBandwidthRateLimitRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteBandwidthRateLimit operation. |
![]() |
DeleteChapCredentials(DeleteChapCredentialsRequest) | This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. |
![]() |
DeleteChapCredentialsAsync(DeleteChapCredentialsRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteChapCredentials operation. |
![]() |
DeleteGateway(DeleteGatewayRequest) |
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. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page. |
![]() |
DeleteGatewayAsync(DeleteGatewayRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteGateway operation. |
![]() |
DeleteSnapshotSchedule(DeleteSnapshotScheduleRequest) |
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 To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference. |
![]() |
DeleteSnapshotScheduleAsync(DeleteSnapshotScheduleRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSnapshotSchedule operation. |
![]() |
DeleteTape(DeleteTapeRequest) | Deletes the specified virtual tape. |
![]() |
DeleteTapeArchive(DeleteTapeArchiveRequest) | Deletes the specified virtual tape from the virtual tape shelf (VTS). |
![]() |
DeleteTapeArchiveAsync(DeleteTapeArchiveRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteTapeArchive operation. |
![]() |
DeleteTapeAsync(DeleteTapeRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteTape operation. |
![]() |
DeleteVolume(DeleteVolumeRequest) |
This operation deletes the specified gateway volume that you previously created using
the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored
volumes, the local disk that was configured as the storage volume is not deleted.
You can reuse the local disk to create another storage volume.
Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. |
![]() |
DeleteVolumeAsync(DeleteVolumeRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteVolume operation. |
![]() |
DescribeBandwidthRateLimit(DescribeBandwidthRateLimitRequest) |
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. |
![]() |
DescribeBandwidthRateLimitAsync(DescribeBandwidthRateLimitRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeBandwidthRateLimit operation. |
![]() |
DescribeCache(DescribeCacheRequest) |
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. |
![]() |
DescribeCacheAsync(DescribeCacheRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCache operation. |
![]() |
DescribeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest) |
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). |
![]() |
DescribeCachediSCSIVolumesAsync(DescribeCachediSCSIVolumesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCachediSCSIVolumes operation. |
![]() |
DescribeChapCredentials(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. |
![]() |
DescribeChapCredentialsAsync(DescribeChapCredentialsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeChapCredentials operation. |
![]() |
DescribeGatewayInformation(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). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. |
![]() |
DescribeGatewayInformationAsync(DescribeGatewayInformationRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeGatewayInformation operation. |
![]() |
DescribeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest) | 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. |
![]() |
DescribeMaintenanceStartTimeAsync(DescribeMaintenanceStartTimeRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeMaintenanceStartTime operation. |
![]() |
DescribeSnapshotSchedule(DescribeSnapshotScheduleRequest) | 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. |
![]() |
DescribeSnapshotScheduleAsync(DescribeSnapshotScheduleRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSnapshotSchedule operation. |
![]() |
DescribeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest) | This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. |
![]() |
DescribeStorediSCSIVolumesAsync(DescribeStorediSCSIVolumesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStorediSCSIVolumes operation. |
![]() |
DescribeTapeArchives() |
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific |
![]() |
DescribeTapeArchives(DescribeTapeArchivesRequest) |
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific |
![]() |
DescribeTapeArchivesAsync(DescribeTapeArchivesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTapeArchives operation. |
![]() |
DescribeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest) |
Returns a list of virtual tape recovery points that are available for the specified
gateway-VTL.
A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. |
![]() |
DescribeTapeRecoveryPointsAsync(DescribeTapeRecoveryPointsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTapeRecoveryPoints operation. |
![]() |
DescribeTapes(DescribeTapesRequest) |
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
If a TapeARN is not specified, returns a description of all virtual tapes
associated with the specified gateway.
|
![]() |
DescribeTapesAsync(DescribeTapesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTapes operation. |
![]() |
DescribeUploadBuffer(DescribeUploadBufferRequest) |
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. |
![]() |
DescribeUploadBufferAsync(DescribeUploadBufferRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeUploadBuffer operation. |
![]() |
DescribeVTLDevices(DescribeVTLDevicesRequest) |
Returns a description of virtual tape library (VTL) devices for the specified gateway.
In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway. |
![]() |
DescribeVTLDevicesAsync(DescribeVTLDevicesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeVTLDevices operation. |
![]() |
DescribeWorkingStorage(DescribeWorkingStorageRequest) |
This operation returns information about the working storage of a gateway. This operation
is supported only for the gateway-stored volume architecture. This operation is deprecated
in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. |
![]() |
DescribeWorkingStorageAsync(DescribeWorkingStorageRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeWorkingStorage operation. |
![]() |
DisableGateway(DisableGatewayRequest) |
Disables a gateway when the gateway is no longer functioning. For example, if your
gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a gateway-VTL that is not reachable or not functioning. |
![]() |
DisableGatewayAsync(DisableGatewayRequest, CancellationToken) | Initiates the asynchronous execution of the DisableGateway operation. |
![]() |
ListGateways() |
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. |
![]() |
ListGateways(ListGatewaysRequest) |
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. |
![]() |
ListGatewaysAsync(ListGatewaysRequest, CancellationToken) | Initiates the asynchronous execution of the ListGateways operation. |
![]() |
ListLocalDisks(ListLocalDisksRequest) |
This operation returns a list of the gateway's local disks. To specify which gateway
to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of
the request.
The request returns a list of all disks, specifying which are configured as working
storage, cache storage, or stored volume or not configured at all. The response includes
a |
![]() |
ListLocalDisksAsync(ListLocalDisksRequest, CancellationToken) | Initiates the asynchronous execution of the ListLocalDisks operation. |
![]() |
ListTagsForResource(ListTagsForResourceRequest) | This operation lists the tags that have been added to the specified resource. |
![]() |
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) | Initiates the asynchronous execution of the ListTagsForResource operation. |
![]() |
ListVolumeInitiators(ListVolumeInitiatorsRequest) | This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. |
![]() |
ListVolumeInitiatorsAsync(ListVolumeInitiatorsRequest, CancellationToken) | Initiates the asynchronous execution of the ListVolumeInitiators operation. |
![]() |
ListVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest) |
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. |
![]() |
ListVolumeRecoveryPointsAsync(ListVolumeRecoveryPointsRequest, CancellationToken) | Initiates the asynchronous execution of the ListVolumeRecoveryPoints operation. |
![]() |
ListVolumes(ListVolumesRequest) |
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 |
![]() |
ListVolumesAsync(ListVolumesRequest, CancellationToken) | Initiates the asynchronous execution of the ListVolumes operation. |
![]() |
RemoveTagsFromResource(RemoveTagsFromResourceRequest) | This operation removes one or more tags from the specified resource. |
![]() |
RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveTagsFromResource operation. |
![]() |
ResetCache(string) |
This operation resets all cache disks that have encountered a error and makes the
disks available for reconfiguration as cache storage. If your cache disk encounters
a error, the gateway prevents read and write operations on virtual tapes in the gateway.
For example, an error can occur when a disk is corrupted or removed from the gateway.
When a cache is reset, the gateway loses its cache storage. At this point you can
reconfigure the disks as cache disks.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. |
![]() |
ResetCache(ResetCacheRequest) |
This operation resets all cache disks that have encountered a error and makes the
disks available for reconfiguration as cache storage. If your cache disk encounters
a error, the gateway prevents read and write operations on virtual tapes in the gateway.
For example, an error can occur when a disk is corrupted or removed from the gateway.
When a cache is reset, the gateway loses its cache storage. At this point you can
reconfigure the disks as cache disks.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. |
![]() |
ResetCacheAsync(ResetCacheRequest, CancellationToken) | Initiates the asynchronous execution of the ResetCache operation. |
![]() |
RetrieveTapeArchive(RetrieveTapeArchiveRequest) |
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL.
Virtual tapes archived in the VTS are not associated with any gateway. However after
a tape is retrieved, it is associated with a gateway, even though it is also listed
in the VTS.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. |
![]() |
RetrieveTapeArchiveAsync(RetrieveTapeArchiveRequest, CancellationToken) | Initiates the asynchronous execution of the RetrieveTapeArchive operation. |
![]() |
RetrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest) |
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. |
![]() |
RetrieveTapeRecoveryPointAsync(RetrieveTapeRecoveryPointRequest, CancellationToken) | Initiates the asynchronous execution of the RetrieveTapeRecoveryPoint operation. |
![]() |
ShutdownGateway(ShutdownGatewayRequest) |
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. 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. 200 OK success
response immediately. However, it might take some time for the gateway to shut down.
You can call the DescribeGatewayInformation API to check the status. For more
information, see ActivateGateway.If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. |
![]() |
ShutdownGatewayAsync(ShutdownGatewayRequest, CancellationToken) | Initiates the asynchronous execution of the ShutdownGateway operation. |
![]() |
StartGateway(StartGatewayRequest) |
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.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. |
![]() |
StartGatewayAsync(StartGatewayRequest, CancellationToken) | Initiates the asynchronous execution of the StartGateway operation. |
![]() |
UpdateBandwidthRateLimit(UpdateBandwidthRateLimitRequest) |
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. |
![]() |
UpdateBandwidthRateLimitAsync(UpdateBandwidthRateLimitRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateBandwidthRateLimit operation. |
![]() |
UpdateChapCredentials(UpdateChapCredentialsRequest) |
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.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. |
![]() |
UpdateChapCredentialsAsync(UpdateChapCredentialsRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateChapCredentials operation. |
![]() |
UpdateGatewayInformation(UpdateGatewayInformationRequest) |
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.
|
![]() |
UpdateGatewayInformationAsync(UpdateGatewayInformationRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateGatewayInformation operation. |
![]() |
UpdateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest) |
This operation updates the gateway virtual machine (VM) software. The request immediately
triggers the software update.
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. |
![]() |
UpdateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateGatewaySoftwareNow operation. |
![]() |
UpdateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest) | 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. |
![]() |
UpdateMaintenanceStartTimeAsync(UpdateMaintenanceStartTimeRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateMaintenanceStartTime operation. |
![]() |
UpdateSnapshotSchedule(UpdateSnapshotScheduleRequest) |
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. |
![]() |
UpdateSnapshotScheduleAsync(UpdateSnapshotScheduleRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateSnapshotSchedule operation. |
![]() |
UpdateVTLDeviceType(UpdateVTLDeviceTypeRequest) | This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. |
![]() |
UpdateVTLDeviceTypeAsync(UpdateVTLDeviceTypeRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateVTLDeviceType operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8