2014/10/16 - AWS Storage Gateway - 47 new api methods
This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
Request Syntax
client.describe_chap_credentials(
TargetARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
dict
Response Syntax
{
'ChapCredentials': [
{
'TargetARN': 'string',
'SecretToAuthenticateInitiator': 'string',
'InitiatorName': 'string',
'SecretToAuthenticateTarget': 'string'
},
]
}
Response Structure
(dict) --
A JSON object containing a .
ChapCredentials (list) --
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
InitiatorName : The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator : The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget : The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN : The Amazon Resource Name (ARN) of the storage volume.
(dict) --
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume.
Valid Values : 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
SecretToAuthenticateInitiator (string) --
The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
InitiatorName (string) --
The iSCSI initiator that connects to the target.
SecretToAuthenticateTarget (string) --
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
Request Syntax
client.update_maintenance_start_time(
GatewayARN='string',
HourOfDay=123,
MinuteOfHour=123,
DayOfWeek=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
integer
[REQUIRED]
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
integer
[REQUIRED]
The minute component of the maintenance start time represented as mm , where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
integer
[REQUIRED]
The maintenance start time day of the week.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose maintenance start time is updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation returns description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.
Request Syntax
client.describe_stored_iscsi_volumes(
VolumeARNs=[
'string',
]
)
list
[REQUIRED]
An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
(string) --
dict
Response Syntax
{
'StorediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'VolumeDiskId': 'string',
'SourceSnapshotId': 'string',
'PreservedExistingData': True|False,
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
}
},
]
}
Response Structure
(dict) --
StorediSCSIVolumes (list) --
(dict) --
VolumeARN (string) --
VolumeId (string) --
VolumeType (string) --
VolumeStatus (string) --
VolumeSizeInBytes (integer) --
VolumeProgress (float) --
VolumeDiskId (string) --
SourceSnapshotId (string) --
PreservedExistingData (boolean) --
VolumeiSCSIAttributes (dict) --
Lists iSCSI information about a volume.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume target.
NetworkInterfaceId (string) --
The network interface identifier.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI targets.
LunNumber (integer) --
The logical disk number.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
Request Syntax
client.delete_volume(
VolumeARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the storage volume that was deleted
VolumeARN (string) --
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.update_bandwidth_rate_limit(
GatewayARN='string',
AverageUploadRateLimitInBitsPerSec=123,
AverageDownloadRateLimitInBitsPerSec=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
integer
The average upload bandwidth rate limit in bits per second.
integer
The average download bandwidth rate limit in bits per second.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose throttle information was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.delete_bandwidth_rate_limit(
GatewayARN='string',
BandwidthType='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
[REQUIRED]
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose bandwidth rate information was deleted.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
Request Syntax
client.describe_upload_buffer(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'UploadBufferUsedInBytes': 123,
'UploadBufferAllocatedInBytes': 123
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
DiskIds (list) --
(string) --
UploadBufferUsedInBytes (integer) --
UploadBufferAllocatedInBytes (integer) --
This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
Request Syntax
client.describe_cached_iscsi_volumes(
VolumeARNs=[
'string',
]
)
list
[REQUIRED]
(string) --
dict
Response Syntax
{
'CachediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'SourceSnapshotId': 'string',
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
}
},
]
}
Response Structure
(dict) --
A JSON object containing the following fields:
CachediSCSIVolumes (list) --
An array of objects where each object contains metadata about one cached volume.
(dict) --
VolumeARN (string) --
VolumeId (string) --
VolumeType (string) --
VolumeStatus (string) --
VolumeSizeInBytes (integer) --
VolumeProgress (float) --
SourceSnapshotId (string) --
VolumeiSCSIAttributes (dict) --
Lists iSCSI information about a volume.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume target.
NetworkInterfaceId (string) --
The network interface identifier.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI targets.
LunNumber (integer) --
The logical disk number.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.
Request Syntax
client.retrieve_tape_archive(
TapeARN='string',
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the retrieved virtual tape.
This operation activates the gateway you previously deployed on your host. For more information, see Downloading and Deploying AWS Storage Gateway VM. In the activation process you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots and the gateway schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account (see UpdateGatewayInformation ).
Note
You must power on the gateway VM before you can activate your gateway.
Request Syntax
client.activate_gateway(
ActivationKey='string',
GatewayName='string',
GatewayTimezone='string',
GatewayRegion='string',
GatewayType='string',
TapeDriveType='string',
MediumChangerType='string'
)
string
[REQUIRED]
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey . It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
string
[REQUIRED]
A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
string
[REQUIRED]
One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
string
[REQUIRED]
One of the values that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary .
Valid Values : "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
string
One of the values that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED .
string
string
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
Note
When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.
Warning
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.
Request Syntax
client.update_gateway_software_now(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway that was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
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.
Request Syntax
client.cancel_retrieval(
GatewayARN='string',
TapeARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelRetrievalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.describe_gateway_information(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayId (string) --
The gateway ID.
GatewayTimezone (string) --
One of the values that indicates the time zone configured for the gateway.
GatewayState (string) --
One of the values that indicates the operating state of the gateway.
GatewayNetworkInterfaces (list) --
A NetworkInterface array that contains descriptions of the gateway network interfaces.
(dict) --
Describes a gateway's network interface.
Ipv4Address (string) --
The Internet Protocol version 4 (IPv4) address of the interface.
MacAddress (string) --
The Media Access Control (MAC) address of the interface.
Note
This is currently unsupported and will not be returned in output.
Ipv6Address (string) --
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported .
GatewayType (string) --
TBD
NextUpdateAvailabilityDate (string) --
The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
Request Syntax
client.describe_maintenance_start_time(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'HourOfDay': 123,
'MinuteOfHour': 123,
'DayOfWeek': 123,
'Timezone': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
HourOfDay (integer) --
MinuteOfHour (integer) --
DayOfWeek (integer) --
Timezone (string) --
This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.describe_bandwidth_rate_limit(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
}
Response Structure
(dict) --
A JSON object containing the following fields:
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
AverageUploadRateLimitInBitsPerSec (integer) --
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
AverageDownloadRateLimitInBitsPerSec (integer) --
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
Note
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
Request Syntax
client.describe_working_storage(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'WorkingStorageUsedInBytes': 123,
'WorkingStorageAllocatedInBytes': 123
}
Response Structure
(dict) --
A JSON object containing the following fields:
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
DiskIds (list) --
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
(string) --
WorkingStorageUsedInBytes (integer) --
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
WorkingStorageAllocatedInBytes (integer) --
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
Request Syntax
client.describe_vtl_devices(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
Marker='string',
Limit=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
list
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
Note
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
(string) --
string
An opaque string that indicates the position at which to begin describing the VTL devices.
integer
Specifies that the number of VTL devices described be limited to the specified number.
dict
Response Syntax
{
'GatewayARN': 'string',
'VTLDevices': [
{
'VTLDeviceARN': 'string',
'VTLDeviceType': 'string',
'VTLDeviceVendor': 'string',
'VTLDeviceProductIdentifier': 'string',
'DeviceiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'ChapEnabled': True|False
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeVTLDevicesOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
VTLDevices (list) --
An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
(dict) --
Represents a device object associated with a gateway-VTL.
VTLDeviceARN (string) --
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
VTLDeviceType (string) --
VTLDeviceVendor (string) --
VTLDeviceProductIdentifier (string) --
DeviceiSCSIAttributes (dict) --
A list of iSCSI information about a VTL device.
TargetARN (string) --
Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
NetworkInterfaceId (string) --
The network interface identifier of the VTL device.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI VTL device targets.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
Marker (string) --
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
Request Syntax
client.describe_snapshot_schedule(
VolumeARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
dict
Response Syntax
{
'VolumeARN': 'string',
'StartAt': 123,
'RecurrenceInHours': 123,
'Description': 'string',
'Timezone': 'string'
}
Response Structure
(dict) --
VolumeARN (string) --
StartAt (integer) --
RecurrenceInHours (integer) --
Description (string) --
Timezone (string) --
This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.
Request Syntax
client.list_gateways(
Marker='string',
Limit=123
)
string
An opaque string that indicates the position at which to begin the returned list of gateways.
integer
Specifies that the list of gateways returned be limited to the specified number of items.
dict
Response Syntax
{
'Gateways': [
{
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Gateways (list) --
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayType (string) --
GatewayOperationalState (string) --
Marker (string) --
This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.update_gateway_information(
GatewayARN='string',
GatewayName='string',
GatewayTimezone='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
string
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway that was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation updates a snapshot schedule configured for a gateway volume.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
Request Syntax
client.update_snapshot_schedule(
VolumeARN='string',
StartAt=123,
RecurrenceInHours=123,
Description='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
integer
[REQUIRED]
The hour of the day at which the snapshot schedule begins represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
integer
[REQUIRED]
Frequency of snapshots. Specify the number of hours between snapshots.
string
Optional description of the snapshot that overwrites the existing description.
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the updated storage volume.
VolumeARN (string) --
This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
Request Syntax
client.add_upload_buffer(
GatewayARN='string',
DiskIds=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
list
[REQUIRED]
(string) --
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.
Request Syntax
client.list_volumes(
GatewayARN='string',
Marker='string',
Limit=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
integer
Specifies that the list of volumes returned be limited to the specified number of items.
dict
Response Syntax
{
'GatewayARN': 'string',
'Marker': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeType': 'string'
},
]
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Marker (string) --
VolumeInfos (list) --
(dict) --
VolumeARN (string) --
VolumeType (string) --
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
Request Syntax
client.describe_tape_recovery_points(
GatewayARN='string',
Marker='string',
Limit=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
integer
Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
dict
Response Syntax
{
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeRecoveryPointsOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
TapeRecoveryPointInfos (list) --
An array of TapeRecoveryPointInfos that are available for the specified gateway.
(dict) --
Describes a recovery point.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeRecoveryPointTime (datetime) --
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tapes to recover.
TapeStatus (string) --
Marker (string) --
An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
Retrieves the recovery point for the specified virtual tape.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
Note
The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.
Request Syntax
client.retrieve_tape_recovery_point(
TapeARN='string',
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeRecoveryPointOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
Request Syntax
client.describe_tape_archives(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
list
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
(string) --
string
An opaque string that indicates the position at which to begin describing virtual tapes.
integer
Specifies that the number of virtual tapes descried be limited to the specified number.
dict
Response Syntax
{
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeArchivesOutput
TapeArchives (list) --
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
(dict) --
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
TapeARN (string) --
The Amazon Resource Name (ARN) of an archived virtual tape.
TapeBarcode (string) --
The barcode that identifies the archived virtual tape.
TapeSizeInBytes (integer) --
The size, in bytes, of the archived virtual tape.
CompletionTime (datetime) --
The time that the archiving of the virtual tape was completed.
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
RetrievedTo (string) --
The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeStatus (string) --
The current state of the archived virtual tape.
Marker (string) --
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
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.
Request Syntax
client.describe_tapes(
GatewayARN='string',
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
list
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.
(string) --
string
A marker value, obtained in a previous call to DescribeTapes . This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
integer
Specifies that the number of virtual tapes described be limited to the specified number.
Note
Amazon Web Services may impose its own limit, if this field is not set.
dict
Response Syntax
{
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapesOutput
Tapes (list) --
An array of virtual tape descriptions.
(dict) --
Describes a virtual tape object.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape.
TapeStatus (string) --
The current state of the virtual tape.
VTLDevice (string) --
The virtual tape library (VTL) device that the virtual tape is associated with.
Progress (float) --
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
Marker (string) --
An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
This operation initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .
Request Syntax
client.create_snapshot(
VolumeARN='string',
SnapshotDescription='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
string
[REQUIRED]
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
dict
Response Syntax
{
'VolumeARN': 'string',
'SnapshotId': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
SnapshotId (string) --
The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or creating a volume from a snapshot ( CreateStorediSCSIVolume ).
This operation deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).
Note
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference .
Request Syntax
client.delete_snapshot_schedule(
VolumeARN='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
VolumeARN (string) --
This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
Note
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
Note
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway ) to no longer pay software charges associated with the gateway.
Request Syntax
client.shutdown_gateway(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway that was shut down.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints.
In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference .
Request Syntax
client.create_snapshot_from_volume_recovery_point(
VolumeARN='string',
SnapshotDescription='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'SnapshotId': 'string',
'VolumeARN': 'string',
'VolumeRecoveryPointTime': 'string'
}
Response Structure
(dict) --
SnapshotId (string) --
VolumeARN (string) --
VolumeRecoveryPointTime (string) --
This operation starts a gateway that you previously shut down (see ShutdownGateway ). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
Note
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
client.start_gateway(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway that was restarted.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
Note
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Request Syntax
client.create_tapes(
GatewayARN='string',
TapeSizeInBytes=123,
ClientToken='string',
NumTapesToCreate=123,
TapeBarcodePrefix='string'
)
string
[REQUIRED]
The unique Amazon Resource Name(ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.
integer
[REQUIRED]
The size, in bytes, of the virtual tapes you want to create.
Note
The size must be gigabyte (1024*1024*1024 byte) aligned.
string
[REQUIRED]
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Note
Using the same ClientToken prevents creating the tape multiple times.
integer
[REQUIRED]
The number of virtual tapes you want to create.
string
[REQUIRED]
A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.
Note
The prefix must be 1 to 4 characters in length and must be upper-case letters A-Z.
dict
Response Syntax
{
'TapeARNs': [
'string',
]
}
Response Structure
(dict) --
CreateTapeOutput
TapeARNs (list) --
A list of unique Amazon Resource Named (ARN) the represents the virtual tapes that were created.
(string) --
Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a gateway-VTL that is not reachable or not functioning.
Warning
Once a gateway is disabled it cannot be enabled.
Request Syntax
client.disable_gateway(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
DisableGatewayOutput
GatewayARN (string) --
The unique Amazon Resource Name of the disabled gateway.
This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
Request Syntax
client.describe_cache(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'CacheAllocatedInBytes': 123,
'CacheUsedPercentage': 123.0,
'CacheDirtyPercentage': 123.0,
'CacheHitPercentage': 123.0,
'CacheMissPercentage': 123.0
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
DiskIds (list) --
(string) --
CacheAllocatedInBytes (integer) --
CacheUsedPercentage (float) --
CacheDirtyPercentage (float) --
CacheHitPercentage (float) --
CacheMissPercentage (float) --
Deletes the specified virtual tape from the virtual tape shelf (VTS).
Request Syntax
client.delete_tape_archive(
TapeARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
Warning
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.
Request Syntax
client.delete_gateway(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the deleted gateway.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
Request Syntax
client.delete_chap_credentials(
TargetARN='string',
InitiatorName='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
string
[REQUIRED]
The iSCSI initiator that connects to the target.
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target.
InitiatorName (string) --
The iSCSI initiator that connects to the target.
This operation returns a list of the local disks of a gateway. To specify which gateway to describe you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns all disks, specifying which are configured as working storage, stored volume or not configured at all.
Request Syntax
client.list_local_disks(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'Disks': [
{
'DiskId': 'string',
'DiskPath': 'string',
'DiskNode': 'string',
'DiskSizeInBytes': 123,
'DiskAllocationType': 'string',
'DiskAllocationResource': 'string'
},
]
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Disks (list) --
(dict) --
DiskId (string) --
DiskPath (string) --
DiskNode (string) --
DiskSizeInBytes (integer) --
DiskAllocationType (string) --
DiskAllocationResource (string) --
This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.
Note
Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
Request Syntax
client.add_working_storage(
GatewayARN='string',
DiskIds=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
list
[REQUIRED]
An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
(string) --
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway for which working storage was configured.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
Request Syntax
client.cancel_archival(
GatewayARN='string',
TapeARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelArchivalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.
Warning
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Request Syntax
client.update_chap_credentials(
TargetARN='string',
SecretToAuthenticateInitiator='string',
InitiatorName='string',
SecretToAuthenticateTarget='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
string
[REQUIRED]
The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
string
[REQUIRED]
The iSCSI initiator that connects to the target.
string
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
InitiatorName (string) --
The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts ).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
Request Syntax
client.add_cache(
GatewayARN='string',
DiskIds=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
list
[REQUIRED]
(string) --
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
Request Syntax
client.list_volume_recovery_points(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'VolumeUsageInBytes': 123,
'VolumeRecoveryPointTime': 'string'
},
]
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
VolumeRecoveryPointInfos (list) --
(dict) --
VolumeARN (string) --
VolumeSizeInBytes (integer) --
VolumeUsageInBytes (integer) --
VolumeRecoveryPointTime (string) --
This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.
In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Request Syntax
client.create_stored_iscsi_volume(
GatewayARN='string',
DiskId='string',
SnapshotId='string',
PreserveExistingData=True|False,
TargetName='string',
NetworkInterfaceId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
string
[REQUIRED]
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
string
The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
boolean
[REQUIRED]
Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values : true, false
string
[REQUIRED]
The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
string
[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values : A valid IP address.
dict
Response Syntax
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'TargetARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the configured volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
TargetARN (string) --
he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
Deletes the specified virtual tape.
Request Syntax
client.delete_tape(
GatewayARN='string',
TapeARN='string'
)
string
[REQUIRED]
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the deleted virtual tape.
This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
Note
Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Request Syntax
client.create_cached_iscsi_volume(
GatewayARN='string',
VolumeSizeInBytes=123,
SnapshotId='string',
TargetName='string',
NetworkInterfaceId='string',
ClientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
integer
[REQUIRED]
string
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'VolumeARN': 'string',
'TargetARN': 'string'
}
Response Structure
(dict) --
VolumeARN (string) --
TargetARN (string) --