AWS SDK for .NET Documentation
AmazonStorageGatewayClient Class
AmazonAmazon.StorageGatewayAmazonStorageGatewayClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonStorageGateway. AWS Storage Gateway Service

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

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

Declaration Syntax
C#
public class AmazonStorageGatewayClient : AmazonWebServiceClient, 
	AmazonStorageGateway, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonStorageGatewayClient()()()()
Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonStorageGatewayClient(RegionEndpoint)
Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonStorageGatewayClient(AmazonStorageGatewayConfig)
Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonStorageGatewayClient(AWSCredentials)
Constructs AmazonStorageGatewayClient with AWS Credentials

AmazonStorageGatewayClient(AWSCredentials, RegionEndpoint)
Constructs AmazonStorageGatewayClient with AWS Credentials

AmazonStorageGatewayClient(AWSCredentials, AmazonStorageGatewayConfig)
Constructs AmazonStorageGatewayClient with AWS Credentials and an AmazonStorageGatewayClient Configuration object.

AmazonStorageGatewayClient(String, String)
Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key

AmazonStorageGatewayClient(String, String, RegionEndpoint)
Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key

AmazonStorageGatewayClient(String, String, AmazonStorageGatewayConfig)
Constructs AmazonStorageGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonStorageGatewayClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AmazonStorageGatewayClient(String, String, String)
Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key

AmazonStorageGatewayClient(String, String, String, RegionEndpoint)
Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key

AmazonStorageGatewayClient(String, String, String, AmazonStorageGatewayConfig)
Constructs AmazonStorageGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonStorageGatewayClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

ActivateGateway(ActivateGatewayRequest)

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.


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.


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.


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.

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.


AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginActivateGateway(ActivateGatewayRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ActivateGateway operation.

BeginAddCache(AddCacheRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddCache operation.

BeginAddUploadBuffer(AddUploadBufferRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddUploadBuffer operation.

BeginAddWorkingStorage(AddWorkingStorageRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AddWorkingStorage operation.

BeginCancelArchival(CancelArchivalRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CancelArchival operation.

BeginCancelRetrieval(CancelRetrievalRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CancelRetrieval operation.

BeginCreateCachediSCSIVolume(CreateCachediSCSIVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateCachediSCSIVolume operation.

BeginCreateSnapshot(CreateSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateSnapshot operation.

BeginCreateSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateSnapshotFromVolumeRecoveryPoint operation.

BeginCreateStorediSCSIVolume(CreateStorediSCSIVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateStorediSCSIVolume operation.

BeginCreateTapes(CreateTapesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateTapes operation.

BeginDeleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteBandwidthRateLimit operation.

BeginDeleteChapCredentials(DeleteChapCredentialsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteChapCredentials operation.

BeginDeleteGateway(DeleteGatewayRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteGateway operation.

BeginDeleteSnapshotSchedule(DeleteSnapshotScheduleRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteSnapshotSchedule operation.

BeginDeleteTape(DeleteTapeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteTape operation.

BeginDeleteTapeArchive(DeleteTapeArchiveRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteTapeArchive operation.

BeginDeleteVolume(DeleteVolumeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteVolume operation.

BeginDescribeBandwidthRateLimit(DescribeBandwidthRateLimitRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeBandwidthRateLimit operation.

BeginDescribeCache(DescribeCacheRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeCache operation.

BeginDescribeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeCachediSCSIVolumes operation.

BeginDescribeChapCredentials(DescribeChapCredentialsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeChapCredentials operation.

BeginDescribeGatewayInformation(DescribeGatewayInformationRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeGatewayInformation operation.

BeginDescribeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeMaintenanceStartTime operation.

BeginDescribeSnapshotSchedule(DescribeSnapshotScheduleRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeSnapshotSchedule operation.

BeginDescribeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStorediSCSIVolumes operation.

BeginDescribeTapeArchives(DescribeTapeArchivesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeTapeArchives operation.

BeginDescribeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeTapeRecoveryPoints operation.

BeginDescribeTapes(DescribeTapesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeTapes operation.

BeginDescribeUploadBuffer(DescribeUploadBufferRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeUploadBuffer operation.

BeginDescribeVTLDevices(DescribeVTLDevicesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeVTLDevices operation.

BeginDescribeWorkingStorage(DescribeWorkingStorageRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeWorkingStorage operation.

BeginDisableGateway(DisableGatewayRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DisableGateway operation.

BeginListGateways(ListGatewaysRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListGateways operation.

BeginListLocalDisks(ListLocalDisksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListLocalDisks operation.

BeginListVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListVolumeRecoveryPoints operation.

BeginListVolumes(ListVolumesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListVolumes operation.

BeginRetrieveTapeArchive(RetrieveTapeArchiveRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RetrieveTapeArchive operation.

BeginRetrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RetrieveTapeRecoveryPoint operation.

BeginShutdownGateway(ShutdownGatewayRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ShutdownGateway operation.

BeginStartGateway(StartGatewayRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StartGateway operation.

BeginUpdateBandwidthRateLimit(UpdateBandwidthRateLimitRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateBandwidthRateLimit operation.

BeginUpdateChapCredentials(UpdateChapCredentialsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateChapCredentials operation.

BeginUpdateGatewayInformation(UpdateGatewayInformationRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateGatewayInformation operation.

BeginUpdateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateGatewaySoftwareNow operation.

BeginUpdateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateMaintenanceStartTime operation.

BeginUpdateSnapshotSchedule(UpdateSnapshotScheduleRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateSnapshotSchedule operation.

CancelArchival(CancelArchivalRequest)

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.


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.


CreateCachediSCSIVolume(CreateCachediSCSIVolumeRequest)

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.


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.

NOTE:To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .


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


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.


CreateTapes(CreateTapesRequest)

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.


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.


DeleteChapCredentials(DeleteChapCredentialsRequest)

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


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.

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.


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


DeleteTape(DeleteTapeRequest)

Deletes the specified virtual tape.


DeleteTapeArchive(DeleteTapeArchiveRequest)

Deletes the specified virtual tape from the virtual tape shelf (VTS).


DeleteVolume(DeleteVolumeRequest)

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.


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.


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.


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).


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.


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.


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.


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.


DescribeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest)

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.


DescribeTapeArchives(DescribeTapeArchivesRequest)

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.


DescribeTapeArchives()()()()

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.


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.


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.


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.


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.


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.

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.


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.

IMPORTANT:Once a gateway is disabled it cannot be enabled.


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndActivateGateway(IAsyncResult)
Finishes the asynchronous execution of the ActivateGateway operation.

EndAddCache(IAsyncResult)
Finishes the asynchronous execution of the AddCache operation.

EndAddUploadBuffer(IAsyncResult)
Finishes the asynchronous execution of the AddUploadBuffer operation.

EndAddWorkingStorage(IAsyncResult)
Finishes the asynchronous execution of the AddWorkingStorage operation.

EndCancelArchival(IAsyncResult)
Finishes the asynchronous execution of the CancelArchival operation.

EndCancelRetrieval(IAsyncResult)
Finishes the asynchronous execution of the CancelRetrieval operation.

EndCreateCachediSCSIVolume(IAsyncResult)
Finishes the asynchronous execution of the CreateCachediSCSIVolume operation.

EndCreateSnapshot(IAsyncResult)
Finishes the asynchronous execution of the CreateSnapshot operation.

EndCreateSnapshotFromVolumeRecoveryPoint(IAsyncResult)
Finishes the asynchronous execution of the CreateSnapshotFromVolumeRecoveryPoint operation.

EndCreateStorediSCSIVolume(IAsyncResult)
Finishes the asynchronous execution of the CreateStorediSCSIVolume operation.

EndCreateTapes(IAsyncResult)
Finishes the asynchronous execution of the CreateTapes operation.

EndDeleteBandwidthRateLimit(IAsyncResult)
Finishes the asynchronous execution of the DeleteBandwidthRateLimit operation.

EndDeleteChapCredentials(IAsyncResult)
Finishes the asynchronous execution of the DeleteChapCredentials operation.

EndDeleteGateway(IAsyncResult)
Finishes the asynchronous execution of the DeleteGateway operation.

EndDeleteSnapshotSchedule(IAsyncResult)
Finishes the asynchronous execution of the DeleteSnapshotSchedule operation.

EndDeleteTape(IAsyncResult)
Finishes the asynchronous execution of the DeleteTape operation.

EndDeleteTapeArchive(IAsyncResult)
Finishes the asynchronous execution of the DeleteTapeArchive operation.

EndDeleteVolume(IAsyncResult)
Finishes the asynchronous execution of the DeleteVolume operation.

EndDescribeBandwidthRateLimit(IAsyncResult)
Finishes the asynchronous execution of the DescribeBandwidthRateLimit operation.

EndDescribeCache(IAsyncResult)
Finishes the asynchronous execution of the DescribeCache operation.

EndDescribeCachediSCSIVolumes(IAsyncResult)
Finishes the asynchronous execution of the DescribeCachediSCSIVolumes operation.

EndDescribeChapCredentials(IAsyncResult)
Finishes the asynchronous execution of the DescribeChapCredentials operation.

EndDescribeGatewayInformation(IAsyncResult)
Finishes the asynchronous execution of the DescribeGatewayInformation operation.

EndDescribeMaintenanceStartTime(IAsyncResult)
Finishes the asynchronous execution of the DescribeMaintenanceStartTime operation.

EndDescribeSnapshotSchedule(IAsyncResult)
Finishes the asynchronous execution of the DescribeSnapshotSchedule operation.

EndDescribeStorediSCSIVolumes(IAsyncResult)
Finishes the asynchronous execution of the DescribeStorediSCSIVolumes operation.

EndDescribeTapeArchives(IAsyncResult)
Finishes the asynchronous execution of the DescribeTapeArchives operation.

EndDescribeTapeRecoveryPoints(IAsyncResult)
Finishes the asynchronous execution of the DescribeTapeRecoveryPoints operation.

EndDescribeTapes(IAsyncResult)
Finishes the asynchronous execution of the DescribeTapes operation.

EndDescribeUploadBuffer(IAsyncResult)
Finishes the asynchronous execution of the DescribeUploadBuffer operation.

EndDescribeVTLDevices(IAsyncResult)
Finishes the asynchronous execution of the DescribeVTLDevices operation.

EndDescribeWorkingStorage(IAsyncResult)
Finishes the asynchronous execution of the DescribeWorkingStorage operation.

EndDisableGateway(IAsyncResult)
Finishes the asynchronous execution of the DisableGateway operation.

EndListGateways(IAsyncResult)
Finishes the asynchronous execution of the ListGateways operation.

EndListLocalDisks(IAsyncResult)
Finishes the asynchronous execution of the ListLocalDisks operation.

EndListVolumeRecoveryPoints(IAsyncResult)
Finishes the asynchronous execution of the ListVolumeRecoveryPoints operation.

EndListVolumes(IAsyncResult)
Finishes the asynchronous execution of the ListVolumes operation.

EndRetrieveTapeArchive(IAsyncResult)
Finishes the asynchronous execution of the RetrieveTapeArchive operation.

EndRetrieveTapeRecoveryPoint(IAsyncResult)
Finishes the asynchronous execution of the RetrieveTapeRecoveryPoint operation.

EndShutdownGateway(IAsyncResult)
Finishes the asynchronous execution of the ShutdownGateway operation.

EndStartGateway(IAsyncResult)
Finishes the asynchronous execution of the StartGateway operation.

EndUpdateBandwidthRateLimit(IAsyncResult)
Finishes the asynchronous execution of the UpdateBandwidthRateLimit operation.

EndUpdateChapCredentials(IAsyncResult)
Finishes the asynchronous execution of the UpdateChapCredentials operation.

EndUpdateGatewayInformation(IAsyncResult)
Finishes the asynchronous execution of the UpdateGatewayInformation operation.

EndUpdateGatewaySoftwareNow(IAsyncResult)
Finishes the asynchronous execution of the UpdateGatewaySoftwareNow operation.

EndUpdateMaintenanceStartTime(IAsyncResult)
Finishes the asynchronous execution of the UpdateMaintenanceStartTime operation.

EndUpdateSnapshotSchedule(IAsyncResult)
Finishes the asynchronous execution of the UpdateSnapshotSchedule operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
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.


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.


ListLocalDisks(ListLocalDisksRequest)

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.


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.


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


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.


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.

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-VTL. There is no charge for retrieving recovery points.


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.

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.


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.

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.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
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.


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.

IMPORTANT: When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.


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.


UpdateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest)

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.


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.


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.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonStorageGatewayClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)