AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 3.5
 

Classes

NameDescription
Class ActivateGatewayRequest Container for the parameters to the ActivateGateway operation. 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. You must turn on the gateway VM before you can activate your gateway.
Class ActivateGatewayResponse Configuration for accessing Amazon ActivateGateway service
Class ActivateGatewayResult AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization. For Gateways activated prior to September 02, 2015 the gateway ARN contains the gateway name rather than the gateway id. Changing the name of the gateway has no effect on the gateway ARN.
Class AddCacheRequest Container for the parameters to the AddCache operation. 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.

Class AddCacheResponse Configuration for accessing Amazon AddCache service
Class AddCacheResult
Class AddTagsToResourceRequest Container for the parameters to the AddTagsToResource operation. 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:
  • Storage gateways of all types

  • Storage Volumes

  • Virtual Tapes

You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

Class AddTagsToResourceResponse Configuration for accessing Amazon AddTagsToResource service
Class AddTagsToResourceResult AddTagsToResourceOutput
Class AddUploadBufferRequest Container for the parameters to the AddUploadBuffer operation. 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.

Class AddUploadBufferResponse Configuration for accessing Amazon AddUploadBuffer service
Class AddUploadBufferResult
Class AddWorkingStorageRequest Container for the parameters to the AddWorkingStorage operation. 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.

Class AddWorkingStorageResponse Configuration for accessing Amazon AddWorkingStorage service
Class AddWorkingStorageResult A JSON object containing the of the gateway for which working storage was configured.
Class CachediSCSIVolume
Class CancelArchivalRequest Container for the parameters to the CancelArchival operation. Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
Class CancelArchivalResponse Configuration for accessing Amazon CancelArchival service
Class CancelArchivalResult CancelArchivalOutput
Class CancelRetrievalRequest Container for the parameters to the CancelRetrieval operation. 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.
Class CancelRetrievalResponse Configuration for accessing Amazon CancelRetrieval service
Class CancelRetrievalResult CancelRetrievalOutput
Class ChapInfo Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
Class CreateCachediSCSIVolumeRequest Container for the parameters to the CreateCachediSCSIVolume operation. This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Class CreateCachediSCSIVolumeResponse Configuration for accessing Amazon CreateCachediSCSIVolume service
Class CreateCachediSCSIVolumeResult
Class CreateSnapshotFromVolumeRecoveryPointRequest Container for the parameters to the CreateSnapshotFromVolumeRecoveryPoint operation. 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.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

Class CreateSnapshotFromVolumeRecoveryPointResponse Configuration for accessing Amazon CreateSnapshotFromVolumeRecoveryPoint service
Class CreateSnapshotFromVolumeRecoveryPointResult
Class CreateSnapshotRequest Container for the parameters to the CreateSnapshot operation. 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.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.
Class CreateSnapshotResponse Configuration for accessing Amazon CreateSnapshot service
Class CreateSnapshotResult A JSON object containing the following fields:
Class CreateStorediSCSIVolumeRequest Container for the parameters to the CreateStorediSCSIVolume operation. 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.

Class CreateStorediSCSIVolumeResponse Configuration for accessing Amazon CreateStorediSCSIVolume service
Class CreateStorediSCSIVolumeResult A JSON object containing the following fields:
Class CreateTapesRequest Container for the parameters to the CreateTapes operation. Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Class CreateTapesResponse Configuration for accessing Amazon CreateTapes service
Class CreateTapesResult CreateTapeOutput
Class CreateTapeWithBarcodeRequest Container for the parameters to the CreateTapeWithBarcode operation. Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
Class CreateTapeWithBarcodeResponse Configuration for accessing Amazon CreateTapeWithBarcode service
Class CreateTapeWithBarcodeResult CreateTapeOutput
Class DeleteBandwidthRateLimitRequest Container for the parameters to the DeleteBandwidthRateLimit operation. 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.
Class DeleteBandwidthRateLimitResponse Configuration for accessing Amazon DeleteBandwidthRateLimit service
Class DeleteBandwidthRateLimitResult A JSON object containing the of the gateway whose bandwidth rate information was deleted.
Class DeleteChapCredentialsRequest Container for the parameters to the DeleteChapCredentials operation. This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
Class DeleteChapCredentialsResponse Configuration for accessing Amazon DeleteChapCredentials service
Class DeleteChapCredentialsResult A JSON object containing the following fields:
Class DeleteGatewayRequest Container for the parameters to the DeleteGateway operation. 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.

Class DeleteGatewayResponse Configuration for accessing Amazon DeleteGateway service
Class DeleteGatewayResult A JSON object containing the id of the deleted gateway.
Class DeleteSnapshotScheduleRequest Container for the parameters to the DeleteSnapshotSchedule operation. 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).

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

Class DeleteSnapshotScheduleResponse Configuration for accessing Amazon DeleteSnapshotSchedule service
Class DeleteSnapshotScheduleResult
Class DeleteTapeArchiveRequest Container for the parameters to the DeleteTapeArchive operation. Deletes the specified virtual tape from the virtual tape shelf (VTS).
Class DeleteTapeArchiveResponse Configuration for accessing Amazon DeleteTapeArchive service
Class DeleteTapeArchiveResult DeleteTapeArchiveOutput
Class DeleteTapeRequest Container for the parameters to the DeleteTape operation. Deletes the specified virtual tape.
Class DeleteTapeResponse Configuration for accessing Amazon DeleteTape service
Class DeleteTapeResult DeleteTapeOutput
Class DeleteVolumeRequest Container for the parameters to the DeleteVolume operation. 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.

Class DeleteVolumeResponse Configuration for accessing Amazon DeleteVolume service
Class DeleteVolumeResult A JSON object containing the of the storage volume that was deleted
Class DescribeBandwidthRateLimitRequest Container for the parameters to the DescribeBandwidthRateLimit operation. 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.

Class DescribeBandwidthRateLimitResponse Configuration for accessing Amazon DescribeBandwidthRateLimit service
Class DescribeBandwidthRateLimitResult A JSON object containing the following fields:
Class DescribeCachediSCSIVolumesRequest Container for the parameters to the DescribeCachediSCSIVolumes operation. 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).

Class DescribeCachediSCSIVolumesResponse Configuration for accessing Amazon DescribeCachediSCSIVolumes service
Class DescribeCachediSCSIVolumesResult A JSON object containing the following fields:
Class DescribeCacheRequest Container for the parameters to the DescribeCache operation. 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.

Class DescribeCacheResponse Configuration for accessing Amazon DescribeCache service
Class DescribeCacheResult
Class DescribeChapCredentialsRequest Container for the parameters to the DescribeChapCredentials operation. This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
Class DescribeChapCredentialsResponse Configuration for accessing Amazon DescribeChapCredentials service
Class DescribeChapCredentialsResult A JSON object containing a .
Class DescribeGatewayInformationRequest Container for the parameters to the DescribeGatewayInformation operation. 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.
Class DescribeGatewayInformationResponse Configuration for accessing Amazon DescribeGatewayInformation service
Class DescribeGatewayInformationResult A JSON object containing the following fields:
Class DescribeMaintenanceStartTimeRequest Container for the parameters to the DescribeMaintenanceStartTime operation. 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.
Class DescribeMaintenanceStartTimeResponse Configuration for accessing Amazon DescribeMaintenanceStartTime service
Class DescribeMaintenanceStartTimeResult
Class DescribeSnapshotScheduleRequest Container for the parameters to the DescribeSnapshotSchedule operation. 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.
Class DescribeSnapshotScheduleResponse Configuration for accessing Amazon DescribeSnapshotSchedule service
Class DescribeSnapshotScheduleResult
Class DescribeStorediSCSIVolumesRequest Container for the parameters to the DescribeStorediSCSIVolumes operation. 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.
Class DescribeStorediSCSIVolumesResponse Configuration for accessing Amazon DescribeStorediSCSIVolumes service
Class DescribeStorediSCSIVolumesResult
Class DescribeTapeArchivesRequest Container for the parameters to the DescribeTapeArchives operation. 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.

Class DescribeTapeArchivesResponse Configuration for accessing Amazon DescribeTapeArchives service
Class DescribeTapeArchivesResult DescribeTapeArchivesOutput
Class DescribeTapeRecoveryPointsRequest Container for the parameters to the DescribeTapeRecoveryPoints operation. 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.

Class DescribeTapeRecoveryPointsResponse Configuration for accessing Amazon DescribeTapeRecoveryPoints service
Class DescribeTapeRecoveryPointsResult DescribeTapeRecoveryPointsOutput
Class DescribeTapesRequest Container for the parameters to the DescribeTapes operation. 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.
Class DescribeTapesResponse Configuration for accessing Amazon DescribeTapes service
Class DescribeTapesResult DescribeTapesOutput
Class DescribeUploadBufferRequest Container for the parameters to the DescribeUploadBuffer operation. 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.

Class DescribeUploadBufferResponse Configuration for accessing Amazon DescribeUploadBuffer service
Class DescribeUploadBufferResult
Class DescribeVTLDevicesRequest Container for the parameters to the DescribeVTLDevices operation. 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.

Class DescribeVTLDevicesResponse Configuration for accessing Amazon DescribeVTLDevices service
Class DescribeVTLDevicesResult DescribeVTLDevicesOutput
Class DescribeWorkingStorageRequest Container for the parameters to the DescribeWorkingStorage operation. 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.

Class DescribeWorkingStorageResponse Configuration for accessing Amazon DescribeWorkingStorage service
Class DescribeWorkingStorageResult A JSON object containing the following fields:
Class DeviceiSCSIAttributes Lists iSCSI information about a VTL device.
Class DisableGatewayRequest Container for the parameters to the DisableGateway operation. 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.

Once a gateway is disabled it cannot be enabled.
Class DisableGatewayResponse Configuration for accessing Amazon DisableGateway service
Class DisableGatewayResult DisableGatewayOutput
Class Disk
Class GatewayInfo
Class InternalServerErrorException StorageGateway exception
Class InvalidGatewayRequestException StorageGateway exception
Class ListGatewaysRequest Container for the parameters to the ListGateways operation. 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.

Class ListGatewaysResponse Configuration for accessing Amazon ListGateways service
Class ListGatewaysResult
Class ListLocalDisksRequest Container for the parameters to the ListLocalDisks operation. 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 DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Class ListLocalDisksResponse Configuration for accessing Amazon ListLocalDisks service
Class ListLocalDisksResult
Class ListTagsForResourceRequest Container for the parameters to the ListTagsForResource operation. This operation lists the tags that have been added to the specified resource.
Class ListTagsForResourceResponse Configuration for accessing Amazon ListTagsForResource service
Class ListTagsForResourceResult ListTagsForResourceOutput
Class ListVolumeInitiatorsRequest Container for the parameters to the ListVolumeInitiators operation. 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.
Class ListVolumeInitiatorsResponse Configuration for accessing Amazon ListVolumeInitiators service
Class ListVolumeInitiatorsResult ListVolumeInitiatorsOutput
Class ListVolumeRecoveryPointsRequest Container for the parameters to the ListVolumeRecoveryPoints operation. 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.

Class ListVolumeRecoveryPointsResponse Configuration for accessing Amazon ListVolumeRecoveryPoints service
Class ListVolumeRecoveryPointsResult
Class ListVolumesRequest Container for the parameters to the ListVolumes operation. 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.

Class ListVolumesResponse Configuration for accessing Amazon ListVolumes service
Class ListVolumesResult
Class NetworkInterface Describes a gateway's network interface.
Class RemoveTagsFromResourceRequest Container for the parameters to the RemoveTagsFromResource operation. This operation removes one or more tags from the specified resource.
Class RemoveTagsFromResourceResponse Configuration for accessing Amazon RemoveTagsFromResource service
Class RemoveTagsFromResourceResult RemoveTagsFromResourceOutput
Class ResetCacheRequest Container for the parameters to the ResetCache operation. 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.

Class ResetCacheResponse Configuration for accessing Amazon ResetCache service
Class ResetCacheResult
Class RetrieveTapeArchiveRequest Container for the parameters to the RetrieveTapeArchive operation. 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.

Class RetrieveTapeArchiveResponse Configuration for accessing Amazon RetrieveTapeArchive service
Class RetrieveTapeArchiveResult RetrieveTapeArchiveOutput
Class RetrieveTapeRecoveryPointRequest Container for the parameters to the RetrieveTapeRecoveryPoint operation. 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.

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.
Class RetrieveTapeRecoveryPointResponse Configuration for accessing Amazon RetrieveTapeRecoveryPoint service
Class RetrieveTapeRecoveryPointResult RetrieveTapeRecoveryPointOutput
Class ShutdownGatewayRequest Container for the parameters to the ShutdownGateway operation. 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.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Class ShutdownGatewayResponse Configuration for accessing Amazon ShutdownGateway service
Class ShutdownGatewayResult A JSON object containing the of the gateway that was shut down.
Class StartGatewayRequest Container for the parameters to the StartGateway operation. 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. 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.

Class StartGatewayResponse Configuration for accessing Amazon StartGateway service
Class StartGatewayResult A JSON object containing the of the gateway that was restarted.
Class StorageGatewayError Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.
Class StorediSCSIVolume
Class Tag
Class Tape Describes a virtual tape object.
Class TapeArchive Represents a virtual tape that is archived in the virtual tape shelf (VTS).
Class TapeRecoveryPointInfo Describes a recovery point.
Class UpdateBandwidthRateLimitRequest Container for the parameters to the UpdateBandwidthRateLimit operation. 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.

Class UpdateBandwidthRateLimitResponse Configuration for accessing Amazon UpdateBandwidthRateLimit service
Class UpdateBandwidthRateLimitResult A JSON object containing the of the gateway whose throttle information was updated.
Class UpdateChapCredentialsRequest Container for the parameters to the UpdateChapCredentials operation. 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.

Class UpdateChapCredentialsResponse Configuration for accessing Amazon UpdateChapCredentials service
Class UpdateChapCredentialsResult A JSON object containing the following fields:
Class UpdateGatewayInformationRequest Container for the parameters to the UpdateGatewayInformation operation. 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. For Gateways activated after September 02, 2015, the gateway's ARN contains the gateway id rather than the gateway name. However changing the name of the gateway has no effect on the gateway's ARN.
Class UpdateGatewayInformationResponse Configuration for accessing Amazon UpdateGatewayInformation service
Class UpdateGatewayInformationResult A JSON object containing the ARN of the gateway that was updated.
Class UpdateGatewaySoftwareNowRequest Container for the parameters to the UpdateGatewaySoftwareNow operation. This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
Class UpdateGatewaySoftwareNowResponse Configuration for accessing Amazon UpdateGatewaySoftwareNow service
Class UpdateGatewaySoftwareNowResult A JSON object containing the of the gateway that was updated.
Class UpdateMaintenanceStartTimeRequest Container for the parameters to the UpdateMaintenanceStartTime operation. 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.
Class UpdateMaintenanceStartTimeResponse Configuration for accessing Amazon UpdateMaintenanceStartTime service
Class UpdateMaintenanceStartTimeResult A JSON object containing the of the gateway whose maintenance start time is updated.
Class UpdateSnapshotScheduleRequest Container for the parameters to the UpdateSnapshotSchedule operation. 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.

Class UpdateSnapshotScheduleResponse Configuration for accessing Amazon UpdateSnapshotSchedule service
Class UpdateSnapshotScheduleResult A JSON object containing the of the updated storage volume.
Class UpdateVTLDeviceTypeRequest Container for the parameters to the UpdateVTLDeviceType operation. 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.
Class UpdateVTLDeviceTypeResponse Configuration for accessing Amazon UpdateVTLDeviceType service
Class UpdateVTLDeviceTypeResult UpdateVTLDeviceTypeOutput
Class VolumeInfo
Class VolumeiSCSIAttributes Lists iSCSI information about a volume.
Class VolumeRecoveryPointInfo
Class VTLDevice Represents a device object associated with a gateway-VTL.