2017/11/21 - AWS Storage Gateway - 1 new5 updated api methods
Changes Update storagegateway client to latest version
Sends you notification when all file data written to the NFS file share has been uploaded to Amazon S3.
AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch event. You can configure CloudWatch Events to sent the notification through event targets such as email, SNS or a Lambda function. text or Lambda functions. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
client.notify_when_uploaded(
FileShareARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the file share.
dict
Response Syntax
{
'FileShareARN': 'string',
'NotificationId': 'string'
}
Response Structure
(dict) --
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
NotificationId (string) --
The randomly generated ID of the notification that was sent. This ID is in UUID format.
{'CachediSCSIVolumes': {'VolumeUsedInBytes': 'long'}}
Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
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),
'VolumeUsedInBytes': 123
},
]
}
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, in bytes, of the volume capacity.
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) --
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
VolumeUsedInBytes (integer) --
The size of the data stored on the volume in bytes.
{'StorediSCSIVolumes': {'VolumeUsedInBytes': 'long'}}
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 type.
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),
'VolumeUsedInBytes': 123
},
]
}
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) --
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
VolumeUsedInBytes (integer) --
The size of the data stored on the volume in bytes.