@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSStorageGateway
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSStorageGateway instead.
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:
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error Responses: Provides reference information about AWS Storage Gateway errors.
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
AWS Storage Gateway Regions and Endpoints: Provides a list of each region and endpoints available for use with AWS Storage Gateway.
AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2
expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For
example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID
with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave
as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ActivateGatewayResult |
activateGateway(ActivateGatewayRequest activateGatewayRequest)
Activates the gateway you previously deployed on your host.
|
AddCacheResult |
addCache(AddCacheRequest addCacheRequest)
Configures one or more gateway local disks as cache for a gateway.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds one or more tags to the specified resource.
|
AddUploadBufferResult |
addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
Configures one or more gateway local disks as upload buffer for a specified gateway.
|
AddWorkingStorageResult |
addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
Configures one or more gateway local disks as working storage for a gateway.
|
CancelArchivalResult |
cancelArchival(CancelArchivalRequest cancelArchivalRequest)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
|
CancelRetrievalResult |
cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
initiated.
|
CreateCachediSCSIVolumeResult |
createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest)
Creates a cached volume on a specified cached volume gateway.
|
CreateNFSFileShareResult |
createNFSFileShare(CreateNFSFileShareRequest createNFSFileShareRequest)
Creates a file share on an existing file gateway.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Initiates a snapshot of a volume.
|
CreateSnapshotFromVolumeRecoveryPointResult |
createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
Initiates a snapshot of a gateway from a volume recovery point.
|
CreateStorediSCSIVolumeResult |
createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
Creates a volume on a specified gateway.
|
CreateTapesResult |
createTapes(CreateTapesRequest createTapesRequest)
Creates one or more virtual tapes.
|
CreateTapeWithBarcodeResult |
createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)
Creates a virtual tape by using your own barcode.
|
DeleteBandwidthRateLimitResult |
deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway.
|
DeleteChapCredentialsResult |
deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
pair.
|
DeleteFileShareResult |
deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)
Deletes a file share from a file gateway.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway.
|
DeleteSnapshotScheduleResult |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
Deletes a snapshot of a volume.
|
DeleteTapeResult |
deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape.
|
DeleteTapeArchiveResult |
deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
DeleteVolumeResult |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
CreateStorediSCSIVolume API.
|
DescribeBandwidthRateLimitResult |
describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
Returns the bandwidth rate limits of a gateway.
|
DescribeCacheResult |
describeCache(DescribeCacheRequest describeCacheRequest)
Returns information about the cache of a gateway.
|
DescribeCachediSCSIVolumesResult |
describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest)
Returns a description of the gateway volumes specified in the request.
|
DescribeChapCredentialsResult |
describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified
iSCSI target, one for each target-initiator pair.
|
DescribeGatewayInformationResult |
describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
(whether the gateway is running or not).
|
DescribeMaintenanceStartTimeResult |
describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
Returns your gateway's weekly maintenance start time including the day and time of the week.
|
DescribeNFSFileSharesResult |
describeNFSFileShares(DescribeNFSFileSharesRequest describeNFSFileSharesRequest)
Gets a description for one or more file shares from a file gateway.
|
DescribeSnapshotScheduleResult |
describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
Describes the snapshot schedule for the specified gateway volume.
|
DescribeStorediSCSIVolumesResult |
describeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
Returns the description of the gateway volumes specified in the request.
|
DescribeTapeArchivesResult |
describeTapeArchives()
Simplified method form for invoking the DescribeTapeArchives operation.
|
DescribeTapeArchivesResult |
describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
DescribeTapeRecoveryPointsResult |
describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
DescribeTapesResult |
describeTapes(DescribeTapesRequest describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
DescribeUploadBufferResult |
describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
Returns information about the upload buffer of a gateway.
|
DescribeVTLDevicesResult |
describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
DescribeWorkingStorageResult |
describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
Returns information about the working storage of a gateway.
|
DisableGatewayResult |
disableGateway(DisableGatewayRequest disableGatewayRequest)
Disables a tape gateway when the gateway is no longer functioning.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListFileSharesResult |
listFileShares(ListFileSharesRequest listFileSharesRequest)
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.
|
ListGatewaysResult |
listGateways()
Simplified method form for invoking the ListGateways operation.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request.
|
ListLocalDisksResult |
listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
Returns a list of the gateway's local disks.
|
ListTagsForResourceResult |
listTagsForResource()
Simplified method form for invoking the ListTagsForResource operation.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that have been added to the specified resource.
|
ListTapesResult |
listTapes(ListTapesRequest listTapesRequest)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
|
ListVolumeInitiatorsResult |
listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)
Lists iSCSI initiators that are connected to a volume.
|
ListVolumeRecoveryPointsResult |
listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
Lists the recovery points for a specified gateway.
|
ListVolumesResult |
listVolumes(ListVolumesRequest listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
RefreshCacheResult |
refreshCache(RefreshCacheRequest refreshCacheRequest)
Refreshes the cache for the specified file share.
|
RemoveTagsFromResourceResult |
removeTagsFromResource()
Simplified method form for invoking the RemoveTagsFromResource operation.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes one or more tags from the specified resource.
|
ResetCacheResult |
resetCache(ResetCacheRequest resetCacheRequest)
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache
storage.
|
RetrieveTapeArchiveResult |
retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
|
RetrieveTapeRecoveryPointResult |
retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetLocalConsolePasswordResult |
setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)
Sets the password for your VM local console.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
ShutdownGatewayResult |
shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
Shuts down a gateway.
|
StartGatewayResult |
startGateway(StartGatewayRequest startGatewayRequest)
Starts a gateway that you previously shut down (see ShutdownGateway).
|
UpdateBandwidthRateLimitResult |
updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway.
|
UpdateChapCredentialsResult |
updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
UpdateGatewayInformationResult |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's metadata, which includes the gateway's name and time zone.
|
UpdateGatewaySoftwareNowResult |
updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
UpdateMaintenanceStartTimeResult |
updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week.
|
UpdateNFSFileShareResult |
updateNFSFileShare(UpdateNFSFileShareRequest updateNFSFileShareRequest)
Updates a file share.
|
UpdateSnapshotScheduleResult |
updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
Updates a snapshot schedule configured for a gateway volume.
|
UpdateVTLDeviceTypeResult |
updateVTLDeviceType(UpdateVTLDeviceTypeRequest updateVTLDeviceTypeRequest)
Updates the type of medium changer in a tape gateway.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://storagegateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the
default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://storagegateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)ActivateGatewayResult activateGateway(ActivateGatewayRequest activateGatewayRequest)
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.
activateGatewayRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AddCacheResult addCache(AddCacheRequest addCacheRequest)
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.
addCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
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.
addTagsToResourceRequest - AddTagsToResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AddUploadBufferResult addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
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.
addUploadBufferRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AddWorkingStorageResult addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
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.
addWorkingStorageRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CancelArchivalResult cancelArchival(CancelArchivalRequest cancelArchivalRequest)
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.
cancelArchivalRequest - CancelArchivalInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CancelRetrievalResult cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.
cancelRetrievalRequest - CancelRetrievalInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateCachediSCSIVolumeResult createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest)
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.
createCachediSCSIVolumeRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateNFSFileShareResult createNFSFileShare(CreateNFSFileShareRequest createNFSFileShareRequest)
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.
createNFSFileShareRequest - CreateNFSFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
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.
createSnapshotRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ServiceUnavailableErrorException - An internal server error has occurred because the service is unavailable. For more information, see the
error and message fields.CreateSnapshotFromVolumeRecoveryPointResult createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
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.
createSnapshotFromVolumeRecoveryPointRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ServiceUnavailableErrorException - An internal server error has occurred because the service is unavailable. For more information, see the
error and message fields.CreateStorediSCSIVolumeResult createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
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.
createStorediSCSIVolumeRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateTapeWithBarcodeResult createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)
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.
createTapeWithBarcodeRequest - CreateTapeWithBarcodeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateTapesResult createTapes(CreateTapesRequest createTapesRequest)
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.
createTapesRequest - CreateTapesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteBandwidthRateLimitResult deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
deleteBandwidthRateLimitRequest - A JSON object containing the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteChapCredentialsResult deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
deleteChapCredentialsRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteFileShareResult deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)
Deletes a file share from a file gateway. This operation is only supported in the file gateway architecture.
deleteFileShareRequest - DeleteFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
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.
deleteGatewayRequest - A JSON object containing the id of the gateway to delete.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteSnapshotScheduleResult deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
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.
deleteSnapshotScheduleRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteTapeResult deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape. This operation is only supported in the tape gateway architecture.
deleteTapeRequest - DeleteTapeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteTapeArchiveResult deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture.
deleteTapeArchiveRequest - DeleteTapeArchiveInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteVolumeResult deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
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.
deleteVolumeRequest - A JSON object containing the DeleteVolumeInput$VolumeARN to delete.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeBandwidthRateLimitResult describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
describeBandwidthRateLimitRequest - A JSON object containing the of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeCacheResult describeCache(DescribeCacheRequest describeCacheRequest)
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.
describeCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeCachediSCSIVolumesResult describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest)
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).
describeCachediSCSIVolumesRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeChapCredentialsResult describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
describeChapCredentialsRequest - A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeGatewayInformationResult describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
describeGatewayInformationRequest - A JSON object containing the id of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeMaintenanceStartTimeResult describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
describeMaintenanceStartTimeRequest - A JSON object containing the of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeNFSFileSharesResult describeNFSFileShares(DescribeNFSFileSharesRequest describeNFSFileSharesRequest)
Gets a description for one or more file shares from a file gateway. This operation is only supported in file gateways.
describeNFSFileSharesRequest - DescribeNFSFileSharesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeSnapshotScheduleResult describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
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.
describeSnapshotScheduleRequest - A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeStorediSCSIVolumesResult describeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
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.
describeStorediSCSIVolumesRequest - A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeTapeArchivesResult describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
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.
describeTapeArchivesRequest - DescribeTapeArchivesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeTapeArchivesResult describeTapeArchives()
DescribeTapeRecoveryPointsResult describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
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.
describeTapeRecoveryPointsRequest - DescribeTapeRecoveryPointsInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeTapesResult describeTapes(DescribeTapesRequest 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. This operation
is only supported in the tape gateway architecture.
describeTapesRequest - DescribeTapesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeUploadBufferResult describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
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.
describeUploadBufferRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeVTLDevicesResult describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest)
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.
describeVTLDevicesRequest - DescribeVTLDevicesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeWorkingStorageResult describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
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.
describeWorkingStorageRequest - A JSON object containing the of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DisableGatewayResult disableGateway(DisableGatewayRequest disableGatewayRequest)
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.
disableGatewayRequest - DisableGatewayInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListFileSharesResult listFileShares(ListFileSharesRequest listFileSharesRequest)
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.
listFileSharesRequest - ListFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
listGatewaysRequest - A JSON object containing zero or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListGatewaysResult listGateways()
listGateways(ListGatewaysRequest)ListLocalDisksResult listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
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).
listLocalDisksRequest - A JSON object containing the of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest - ListTagsForResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListTagsForResourceResult listTagsForResource()
ListTapesResult listTapes(ListTapesRequest listTapesRequest)
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.
listTapesRequest - A JSON object that contains one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListVolumeInitiatorsResult listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)
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.
listVolumeInitiatorsRequest - ListVolumeInitiatorsInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListVolumeRecoveryPointsResult listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
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.
listVolumeRecoveryPointsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListVolumesResult listVolumes(ListVolumesRequest listVolumesRequest)
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.
listVolumesRequest - A JSON object that contains one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RefreshCacheResult refreshCache(RefreshCacheRequest refreshCacheRequest)
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.
refreshCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architectures.
removeTagsFromResourceRequest - RemoveTagsFromResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RemoveTagsFromResourceResult removeTagsFromResource()
ResetCacheResult resetCache(ResetCacheRequest resetCacheRequest)
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.
resetCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RetrieveTapeArchiveResult retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
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.
retrieveTapeArchiveRequest - RetrieveTapeArchiveInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RetrieveTapeRecoveryPointResult retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
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.
retrieveTapeRecoveryPointRequest - RetrieveTapeRecoveryPointInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.SetLocalConsolePasswordResult setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)
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.
setLocalConsolePasswordRequest - SetLocalConsolePasswordInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ShutdownGatewayResult shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
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.
shutdownGatewayRequest - A JSON object containing the of the gateway to shut down.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.StartGatewayResult startGateway(StartGatewayRequest startGatewayRequest)
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.
startGatewayRequest - A JSON object containing the of the gateway to start.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateBandwidthRateLimitResult updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
updateBandwidthRateLimitRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateChapCredentialsResult updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
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.
updateChapCredentialsRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
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.
updateGatewayInformationRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateGatewaySoftwareNowResult updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
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.
updateGatewaySoftwareNowRequest - A JSON object containing the of the gateway to update.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateMaintenanceStartTimeResult updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
updateMaintenanceStartTimeRequest - A JSON object containing the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateNFSFileShareResult updateNFSFileShare(UpdateNFSFileShareRequest updateNFSFileShareRequest)
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.
updateNFSFileShareRequest - UpdateNFSFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSnapshotScheduleResult updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
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.
updateSnapshotScheduleRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateVTLDeviceTypeResult updateVTLDeviceType(UpdateVTLDeviceTypeRequest updateVTLDeviceTypeRequest)
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.
updateVTLDeviceTypeRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.