AWS SDK Version 3 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.

Classes

NameDescription
Class ActivateGatewayRequest

Container for the parameters to the ActivateGateway 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 or tapes, 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

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. Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway architectures (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

This is the response object from the AddCache operation.

Class AddTagsToResourceRequest

Container for the parameters to the AddTagsToResource 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

AddTagsToResourceOutput

Class AddUploadBufferRequest

Container for the parameters to the AddUploadBuffer operation. Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway 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

This is the response object from the AddUploadBuffer operation.

Class AddWorkingStorageRequest

Container for the parameters to the AddWorkingStorage operation. Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway architecture. This operation is deprecated in cached volume 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

A JSON object containing the of the gateway for which working storage was configured.

Class CachediSCSIVolume

Describes an iSCSI cached volume.

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. This operation is only supported in the tape gateway architecture.

Class CancelArchivalResponse

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

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. Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway 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, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Class CreateCachediSCSIVolumeResponse

This is the response object from the CreateCachediSCSIVolume operation.

Class CreateNFSFileShareRequest

Container for the parameters to the CreateNFSFileShare operation. Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface. This operation is only supported in the file gateway architecture.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

Class CreateNFSFileShareResponse

CreateNFSFileShareOutput

Class CreateSnapshotFromVolumeRecoveryPointRequest

Container for the parameters to the CreateSnapshotFromVolumeRecoveryPoint operation. Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway architecture.

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 cached volume gateway, 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 the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the 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

This is the response object from the CreateSnapshotFromVolumeRecoveryPoint operation.

Class CreateSnapshotRequest

Container for the parameters to the CreateSnapshot 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 Editing a Snapshot Schedule.

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. This operation is only supported in stored and cached volume gateway architecture.

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.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

Class CreateSnapshotResponse

A JSON object containing the following fields:

Class CreateStorediSCSIVolumeRequest

Container for the parameters to the CreateStorediSCSIVolume operation. Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway 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, the 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

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. This operation is only supported in the tape gateway architecture.

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

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. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway. architecture.

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

CreateTapeOutput

Class DeleteBandwidthRateLimitRequest

Container for the parameters to the DeleteBandwidthRateLimit 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

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

Class DeleteChapCredentialsRequest

Container for the parameters to the DeleteChapCredentials operation. Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Class DeleteChapCredentialsResponse

A JSON object containing the following fields:

Class DeleteFileShareRequest

Container for the parameters to the DeleteFileShare operation. Deletes a file share from a file gateway. This operation is only supported in the file gateway architecture.

Class DeleteFileShareResponse

DeleteFileShareOutput

Class DeleteGatewayRequest

Container for the parameters to the DeleteGateway 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

A JSON object containing the id of the deleted gateway.

Class DeleteSnapshotScheduleRequest

Container for the parameters to the DeleteSnapshotSchedule operation. Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action 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

This is the response object from the DeleteSnapshotSchedule operation.

Class DeleteTapeArchiveRequest

Container for the parameters to the DeleteTapeArchive operation. Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture.

Class DeleteTapeArchiveResponse

DeleteTapeArchiveOutput

Class DeleteTapeRequest

Container for the parameters to the DeleteTape operation. Deletes the specified virtual tape. This operation is only supported in the tape gateway architecture.

Class DeleteTapeResponse

DeleteTapeOutput

Class DeleteVolumeRequest

Container for the parameters to the DeleteVolume operation. Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume architectures. For stored volume gateways, 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 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

A JSON object containing the of the storage volume that was deleted

Class DescribeBandwidthRateLimitRequest

Container for the parameters to the DescribeBandwidthRateLimit 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

A JSON object containing the following fields:

Class DescribeCachediSCSIVolumesRequest

Container for the parameters to the DescribeCachediSCSIVolumes operation. Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway 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

A JSON object containing the following fields:

Class DescribeCacheRequest

Container for the parameters to the DescribeCache operation. Returns information about the cache of a gateway. This operation is only supported in the cached volume,tape and file gateway architectures.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Class DescribeCacheResponse

This is the response object from the DescribeCache operation.

Class DescribeChapCredentialsRequest

Container for the parameters to the DescribeChapCredentials 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

A JSON object containing a .

Class DescribeGatewayInformationRequest

Container for the parameters to the DescribeGatewayInformation 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

A JSON object containing the following fields:

Class DescribeMaintenanceStartTimeRequest

Container for the parameters to the DescribeMaintenanceStartTime 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

A JSON object containing the following fields:

Class DescribeNFSFileSharesRequest

Container for the parameters to the DescribeNFSFileShares operation. Gets a description for one or more file shares from a file gateway. This operation is only supported in file gateways.

Class DescribeNFSFileSharesResponse

DescribeNFSFileSharesOutput

Class DescribeSnapshotScheduleRequest

Container for the parameters to the DescribeSnapshotSchedule 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. This operation is only supported in the cached volume and stored volume architectures.

Class DescribeSnapshotScheduleResponse

This is the response object from the DescribeSnapshotSchedule operation.

Class DescribeStorediSCSIVolumesRequest

Container for the parameters to the DescribeStorediSCSIVolumes 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. This operation is only supported in stored volume gateway architecture.

Class DescribeStorediSCSIVolumesResponse

This is the response object from the DescribeStorediSCSIVolumes operation.

Class DescribeTapeArchivesRequest

Container for the parameters to the DescribeTapeArchives operation. Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture.

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

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

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. This operation is only supported in the tape gateway architecture.

Class DescribeTapeRecoveryPointsResponse

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. This operation is only supported in the tape gateway architecture.

Class DescribeTapesResponse

DescribeTapesOutput

Class DescribeUploadBufferRequest

Container for the parameters to the DescribeUploadBuffer operation. Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway 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

This is the response object from the DescribeUploadBuffer operation.

Class DescribeVTLDevicesRequest

Container for the parameters to the DescribeVTLDevices operation. Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway architecture.

Class DescribeVTLDevicesResponse

DescribeVTLDevicesOutput

Class DescribeWorkingStorageRequest

Container for the parameters to the DescribeWorkingStorage operation. Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway 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

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 tape 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 tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway architectures.

Once a gateway is disabled it cannot be enabled.

Class DisableGatewayResponse

DisableGatewayOutput

Class Disk

Class FileShareInfo

Describes a file share.

Class GatewayInfo

Describes a gateway object.

Class InternalServerErrorException

StorageGateway exception

Class InvalidGatewayRequestException

StorageGateway exception

Class ListFileSharesRequest

Container for the parameters to the ListFileShares operation. Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway architecture.

Class ListFileSharesResponse

ListFileShareOutput

Class ListGatewaysRequest

Container for the parameters to the ListGateways 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

This is the response object from the ListGateways operation.

Class ListLocalDisksRequest

Container for the parameters to the ListLocalDisks 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

This is the response object from the ListLocalDisks operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architecture.

Class ListTagsForResourceResponse

ListTagsForResourceOutput

Class ListTapesRequest

Container for the parameters to the ListTapes operation. Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway architecture.

Class ListTapesResponse

A JSON object containing the following fields:

Class ListVolumeInitiatorsRequest

Container for the parameters to the ListVolumeInitiators 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. This operation is only supported in the cached volume and stored volume gateway architecture.

Class ListVolumeInitiatorsResponse

ListVolumeInitiatorsOutput

Class ListVolumeRecoveryPointsRequest

Container for the parameters to the ListVolumeRecoveryPoints operation. Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway architecture.

Each cache 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 or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Class ListVolumeRecoveryPointsResponse

This is the response object from the ListVolumeRecoveryPoints operation.

Class ListVolumesRequest

Container for the parameters to the ListVolumes 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 or the DescribeCachediSCSIVolumes 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. This operation is only supported in the cached volume and stored volume gateway architectures.

Class ListVolumesResponse

This is the response object from the ListVolumes operation.

Class NetworkInterface

Describes a gateway's network interface.

Class NFSFileShareDefaults

Describes file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway architecture.

Class NFSFileShareInfo

The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.

Class RefreshCacheRequest

Container for the parameters to the RefreshCache operation. Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results.

Class RefreshCacheResponse

This is the response object from the RefreshCache operation.

Class RemoveTagsFromResourceRequest

Container for the parameters to the RemoveTagsFromResource operation. Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architectures.

Class RemoveTagsFromResourceResponse

RemoveTagsFromResourceOutput

Class ResetCacheRequest

Container for the parameters to the ResetCache 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. This operation is only supported in the cached volume,tape and file gateway architectures.

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

This is the response object from the ResetCache operation.

Class RetrieveTapeArchiveRequest

Container for the parameters to the RetrieveTapeArchive operation. Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. 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, that is, archive. This operation is only supported in the tape gateway architecture.

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. This operation is only supported in the tape gateway architecture.

Class RetrieveTapeArchiveResponse

RetrieveTapeArchiveOutput

Class RetrieveTapeRecoveryPointRequest

Container for the parameters to the RetrieveTapeRecoveryPoint operation. Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway architecture.

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

Class RetrieveTapeRecoveryPointResponse

RetrieveTapeRecoveryPointOutput

Class ServiceUnavailableErrorException

StorageGateway exception

Class SetLocalConsolePasswordRequest

Container for the parameters to the SetLocalConsolePassword operation. Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

Class SetLocalConsolePasswordResponse

This is the response object from the SetLocalConsolePassword operation.

Class ShutdownGatewayRequest

Container for the parameters to the ShutdownGateway 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 gateway's virtual machine (VM) and not the host 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

A JSON object containing the of the gateway that was shut down.

Class StartGatewayRequest

Container for the parameters to the StartGateway 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

A JSON object containing the of the gateway that was restarted.

Class StorediSCSIVolume

Describes an iSCSI stored volume.

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 TapeInfo

Describes a virtual tape.

Class TapeRecoveryPointInfo

Describes a recovery point.

Class UpdateBandwidthRateLimitRequest

Container for the parameters to the UpdateBandwidthRateLimit 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

A JSON object containing the of the gateway whose throttle information was updated.

Class UpdateChapCredentialsRequest

Container for the parameters to the UpdateChapCredentials 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

A JSON object containing the following fields:

Class UpdateGatewayInformationRequest

Container for the parameters to the UpdateGatewayInformation 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 2, 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

A JSON object containing the ARN of the gateway that was updated.

Class UpdateGatewaySoftwareNowRequest

Container for the parameters to the UpdateGatewaySoftwareNow 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

A JSON object containing the of the gateway that was updated.

Class UpdateMaintenanceStartTimeRequest

Container for the parameters to the UpdateMaintenanceStartTime 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

A JSON object containing the of the gateway whose maintenance start time is updated.

Class UpdateNFSFileShareRequest

Container for the parameters to the UpdateNFSFileShare operation. Updates a file share. This operation is only supported in the file gateway architecture.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share setting:

  • Default storage class for your S3 bucket

  • Metadata defaults for your S3 bucket

  • Allowed NFS clients for your file share

  • Squash settings

  • Write status of your file share

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

Class UpdateNFSFileShareResponse

UpdateNFSFileShareOutput

Class UpdateSnapshotScheduleRequest

Container for the parameters to the UpdateSnapshotSchedule operation. Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway architectures.

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

A JSON object containing the of the updated storage volume.

Class UpdateVTLDeviceTypeRequest

Container for the parameters to the UpdateVTLDeviceType operation. Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway architecture.

Class UpdateVTLDeviceTypeResponse

UpdateVTLDeviceTypeOutput

Class VolumeInfo

Describes a storage volume object.

Class VolumeiSCSIAttributes

Lists iSCSI information about a volume.

Class VolumeRecoveryPointInfo

Class VTLDevice

Represents a device object associated with a tape gateway.