Skip to content

aws.storagegateway.describe_stored_iscsi_volumes

Example SQL Queries

SELECT * FROM
aws.storagegateway.describe_stored_iscsi_volumes
WHERE
"volume_ar_ns" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
volume_ar_ns Required Input Column

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.

VARCHAR[]
Show child fields
volume_ar_ns[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
storedi_scsi_volumes

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.

STRUCT(
"volume_arn" VARCHAR,
"volume_id" VARCHAR,
"volume_type" VARCHAR,
"volume_status" VARCHAR,
"volume_attachment_status" VARCHAR,
"volume_size_in_bytes" BIGINT,
"volume_progress" DOUBLE,
"volume_disk_id" VARCHAR,
"source_snapshot_id" VARCHAR,
"preserved_existing_data" BOOLEAN,
"volumei_scsi_attributes" STRUCT(
"target_arn" VARCHAR,
"network_interface_id" VARCHAR,
"network_interface_port" BIGINT,
"lun_number" BIGINT,
"chap_enabled" BOOLEAN
),
"created_date" TIMESTAMP_S,
"volume_used_in_bytes" BIGINT,
"kms_key" VARCHAR,
"target_name" VARCHAR
)[]
Show child fields
storedi_scsi_volumes[]
Show child fields
storedi_scsi_volumes[].created_date

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

storedi_scsi_volumes[].kms_key

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 can only be set when KMSEncrypted is true. Optional.

storedi_scsi_volumes[].preserved_existing_data

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

Valid Values: true | false

storedi_scsi_volumes[].source_snapshot_id

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.

storedi_scsi_volumes[].target_name

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.

storedi_scsi_volumes[].volume_arn

The Amazon Resource Name (ARN) of the storage volume.

storedi_scsi_volumes[].volume_attachment_status

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.

storedi_scsi_volumes[].volume_disk_id

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

storedi_scsi_volumes[].volume_id

The unique identifier of the volume, e.g., vol-AE4B946D.

storedi_scsi_volumes[].volume_progress

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.

storedi_scsi_volumes[].volume_size_in_bytes

The size of the volume in bytes.

storedi_scsi_volumes[].volume_status

One of the VolumeStatus values that indicates the state of the storage volume.

storedi_scsi_volumes[].volume_type

One of the VolumeType enumeration values describing the type of the volume.

storedi_scsi_volumes[].volume_used_in_bytes

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.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

storedi_scsi_volumes[].volumei_scsi_attributes

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

Show child fields
storedi_scsi_volumes[].volumei_scsi_attributes.chap_enabled

Indicates whether mutual CHAP is enabled for the iSCSI target.

storedi_scsi_volumes[].volumei_scsi_attributes.lun_number

The logical disk number.

storedi_scsi_volumes[].volumei_scsi_attributes.network_interface_id

The network interface identifier.

storedi_scsi_volumes[].volumei_scsi_attributes.network_interface_port

The port used to communicate with iSCSI targets.

storedi_scsi_volumes[].volumei_scsi_attributes.target_arn

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