baiji v0.6.7 Baiji.StorageGateway
AWS Storage Gateway Service
AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization’s on-premises IT environment and AWS’s storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
- [AWS Storage Gateway Required Request Headers](http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders): Describes the required headers that you must send with every POST request to AWS Storage Gateway.
- [Signing Requests](http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests): AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
- [Error Responses](http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses): Provides reference information about AWS Storage Gateway errors.
- [Operations in AWS Storage Gateway](http://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html): 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:](http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region) Provides a list of each region and endpoints available for use with AWS Storage Gateway.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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
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)
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
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
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
- Use
AddUploadBuffer
instead
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
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
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway architecture
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
Initiates a snapshot of a volume
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway architecture
Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway architecture
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
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
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
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair
Deletes a file share from a file gateway. This operation is only supported in the file gateway architecture
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
Deletes a snapshot of a volume
Deletes the specified virtual tape. This operation is only supported in the tape gateway architecture
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture
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
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect
Returns information about the cache of a gateway. This operation is only supported in the cached volume,tape and file gateway architectures
Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway architecture
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair
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
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
Gets a description for one or more file shares from a file gateway. This operation is only supported in file gateways
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
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
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture
Returns a list of virtual tape recovery points that are available for the specified tape gateway
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
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway architectures
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information
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
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
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
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)
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
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
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
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
Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway architecture
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
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
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architectures
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
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
Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway architecture
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
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
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
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
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
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
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update
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
Updates a file share. This operation is only supported in the file gateway architecture
Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway architectures
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
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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
.
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.
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
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.
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
- Use
AddUploadBuffer
instead.
to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
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.
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.
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway architecture.
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.
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.
ID format. For more information, see the important note on the Welcome page.
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.
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.
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.
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.
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.
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
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.
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).
Deletes the specified virtual tape. This operation is only supported in the tape gateway architecture.
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture.
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.
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.
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.
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).
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
storage, and it includes the amount of working storage allocated and used.
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.
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.
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).
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.
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.
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.
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.
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.
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.
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architectures.
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.
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.
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.
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.
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.
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.
gateway (using DeleteGateway
) to no longer pay software charges
associated with the gateway.
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.
(ARN) of the gateway in your request.
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.
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.
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.
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
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.
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.
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.
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.