StorageGateway / Client / describe_stored_iscsi_volumes

describe_stored_iscsi_volumes#

StorageGateway.Client.describe_stored_iscsi_volumes(**kwargs)#

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, 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

response = client.describe_stored_iscsi_volumes(
    VolumeARNs=[
        'string',
    ]
)
Parameters:

VolumeARNs (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 be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

  • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • StorediSCSIVolumes (list) –

      Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

      • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

      • LunNumber: The logical disk number.

      • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

      • NetworkInterfacePort: The port used to communicate with iSCSI targets.

      • PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.

      • SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

      • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

      • TargetARN: The Amazon Resource Name (ARN) of the volume target.

      • VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

      • VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

      • VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

      • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

      • VolumeProgress: 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.

      • VolumeSizeInBytes: The size of the volume in bytes.

      • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

      • VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

      • (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.

        • VolumeAttachmentStatus (string) –

          A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

        • 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 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.

        • 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

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Returns the description of the gateway volumes specified in the request belonging to the same gateway.

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

print(response)

Expected Output:

{
    'StorediSCSIVolumes': [
        {
            'PreservedExistingData': False,
            'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeDiskId': 'pci-0000:03:00.0-scsi-0:0:0:0',
            'VolumeId': 'vol-1122AABB',
            'VolumeProgress': 23.7,
            'VolumeSizeInBytes': 1099511627776,
            'VolumeStatus': 'BOOTSTRAPPING',
            'VolumeiSCSIAttributes': {
                'ChapEnabled': True,
                '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': {
        '...': '...',
    },
}