StorageGateway / Client / describe_cached_iscsi_volumes

describe_cached_iscsi_volumes#

StorageGateway.Client.describe_cached_iscsi_volumes(**kwargs)#

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, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Request Syntax

response = client.describe_cached_iscsi_volumes(
    VolumeARNs=[
        'string',
    ]
)

Parameters:

VolumeARNs (list) –

[REQUIRED]

An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'CachediSCSIVolumes': [
        {
            'VolumeARN': 'string',
            'VolumeId': 'string',
            'VolumeType': 'string',
            'VolumeStatus': 'string',
            'VolumeAttachmentStatus': '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,
            'KMSKey': 'string',
            'TargetName': 'string'
        },
    ]
}

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.
    - VolumeAttachmentStatus (string) –
      
      A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.
    - 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 timestamp.
    - VolumeUsedInBytes (integer) –
      
      The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.
      
      Note
      This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
      
      If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.
    - KMSKey (string) –
      
      Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
    - TargetName (string) –
      
      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
      
      If you don’t specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Exceptions

Examples

Returns a description of the gateway cached iSCSI volumes specified in the request.

response = client.describe_cached_iscsi_volumes(
    VolumeARNs=[
        'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    ],
)

print(response)

Expected Output:

{
    'CachediSCSIVolumes': [
        {
            'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeId': 'vol-1122AABB',
            'VolumeSizeInBytes': 1099511627776,
            'VolumeStatus': 'AVAILABLE',
            'VolumeType': 'CACHED iSCSI',
            'VolumeiSCSIAttributes': {
                'ChapEnabled': True,
                'LunNumber': 1,
                'NetworkInterfaceId': '10.243.43.207',
                'NetworkInterfacePort': 3260,
                'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
            },
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}