StorageGateway / Client / list_volume_initiators

list_volume_initiators#

StorageGateway.Client.list_volume_initiators(**kwargs)#

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

See also: AWS API Documentation

Request Syntax

response = client.list_volume_initiators(
    VolumeARN='string'
)
Parameters:

VolumeARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

Return type:

dict

Returns:

Response Syntax

{
    'Initiators': [
        'string',
    ]
}

Response Structure

  • (dict) –

    ListVolumeInitiatorsOutput

    • Initiators (list) –

      The host names and port numbers of all iSCSI initiators that are connected to the gateway.

      • (string) –

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError