2016/12/20 - AWS Storage Gateway - 5 new 5 updated api methods
Changes File gateway is a new mode in the AWS Storage Gateway that support a file interface into S3, alongside the current block-based volume and VTL storage. File gateway combines a service and virtual software appliance, enabling you to store and retrieve objects in Amazon S3 using industry standard file protocols such as NFS. The software appliance, or gateway, is deployed into your on-premises environment as a virtual machine (VM) running on VMware ESXi. The gateway provides access to objects in S3 as files on a Network File System (NFS) mount point.
{'SourceVolumeARN': 'string'}
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. 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.
See also: AWS API Documentation
Request Syntax
client.create_cached_iscsi_volume( GatewayARN='string', VolumeSizeInBytes=123, SnapshotId='string', TargetName='string', SourceVolumeARN='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
The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{ 'VolumeARN': 'string', 'TargetARN': 'string' }
Response Structure
(dict) --
VolumeARN (string) --
TargetARN (string) --
{'CachediSCSIVolumes': {'CreatedDate': 'timestamp'}}
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).
See also: AWS API Documentation
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 }, 'CreatedDate': datetime(2015, 1, 1) }, ] }
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) --
Describes an iSCSI cached volume.
VolumeARN (string) --
The Amazon Resource Name (ARN) of the storage volume.
VolumeId (string) --
The unique identifier of the volume, e.g. vol-AE4B946D.
VolumeType (string) --
One of the VolumeType enumeration values that describes the type of the volume.
VolumeStatus (string) --
One of the VolumeStatus values that indicates the state of the storage volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
VolumeProgress (float) --
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.
SourceSnapshotId (string) --
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
VolumeiSCSIAttributes (dict) --
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored 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.
CreatedDate (datetime) --
{'StorediSCSIVolumes': {'CreatedDate': 'timestamp'}}
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.
See also: AWS API Documentation
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 }, 'CreatedDate': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) --
StorediSCSIVolumes (list) --
(dict) --
Describes an iSCSI stored volume.
VolumeARN (string) --
The Amazon Resource Name (ARN) of the storage volume.
VolumeId (string) --
The unique identifier of the volume, e.g. vol-AE4B946D.
VolumeType (string) --
One of the VolumeType enumeration values describing the type of the volume.
VolumeStatus (string) --
One of the VolumeStatus values that indicates the state of the storage volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
VolumeProgress (float) --
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
VolumeDiskId (string) --
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
SourceSnapshotId (string) --
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
PreservedExistingData (boolean) --
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true, false
VolumeiSCSIAttributes (dict) --
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored 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.
CreatedDate (datetime) --
{'TapeArchives': {'TapeCreatedDate': 'timestamp'}}
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.
See also: AWS API Documentation
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', 'TapeCreatedDate': datetime(2015, 1, 1), '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.
TapeCreatedDate (datetime) --
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.
{'Tapes': {'TapeCreatedDate': 'timestamp'}}
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.
See also: AWS API Documentation
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', 'TapeCreatedDate': datetime(2015, 1, 1), '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.
TapeCreatedDate (datetime) --
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.