AWS Storage Gateway

{'KMSEncrypted': 'boolean', 'KMSKey': 'string'}

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

See also: AWS API Documentation

Request Syntax

client.create_stored_iscsi_volume(
    GatewayARN='string',
    DiskId='string',
    SnapshotId='string',
    PreserveExistingData=True|False,
    TargetName='string',
    NetworkInterfaceId='string',
    KMSEncrypted=True|False,
    KMSKey='string'
)

type GatewayARN

string

param GatewayARN

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

type DiskId

string

param DiskId

[REQUIRED]

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

type SnapshotId

string

param SnapshotId

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .

type PreserveExistingData

boolean

param PreserveExistingData

[REQUIRED]

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Valid Values: true, false

type TargetName

string

param TargetName

[REQUIRED]

The name of the iSCSI target used by initiators to connect to the target and 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 of a gateway.

type NetworkInterfaceId

string

param NetworkInterfaceId

[REQUIRED]

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

type KMSEncrypted

boolean

param KMSEncrypted

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

type KMSKey

string

param KMSKey

The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

rtype

dict

returns

Response Syntax

{
    'VolumeARN': 'string',
    'VolumeSizeInBytes': 123,
    'TargetARN': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the following fields:

  • VolumeARN (string) --

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

  • VolumeSizeInBytes (integer) --

    The size of the volume in bytes.

  • TargetARN (string) --

    he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.

{'StorediSCSIVolumes': {'KMSKey': 'string'}}

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',
    ]
)

type VolumeARNs

list

param VolumeARNs

[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) --

rtype

dict

returns

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,
            'KMSKey': 'string'
        },
    ]
}

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.

        Note

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

      • KMSKey (string) --

        The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.