AWS Storage Gateway

This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.

Request Syntax

client.list_volume_initiators(
    VolumeARN='string'
)

type VolumeARN:

string

param VolumeARN:

[REQUIRED]

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

rtype:

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

{'LastSoftwareUpdate': 'string'}

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

client.describe_gateway_information(
    GatewayARN='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.

rtype:

dict

returns:

Response Syntax

{
    'GatewayARN': 'string',
    'GatewayId': 'string',
    'GatewayTimezone': 'string',
    'GatewayState': 'string',
    'GatewayNetworkInterfaces': [
        {
            'Ipv4Address': 'string',
            'MacAddress': 'string',
            'Ipv6Address': 'string'
        },
    ],
    'GatewayType': 'string',
    'NextUpdateAvailabilityDate': 'string',
    'LastSoftwareUpdate': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the following fields:

  • GatewayARN (string) --

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

  • GatewayId (string) --

    The gateway ID.

  • GatewayTimezone (string) --

    One of the values that indicates the time zone configured for the gateway.

  • GatewayState (string) --

    One of the values that indicates the operating state of the gateway.

  • GatewayNetworkInterfaces (list) --

    A NetworkInterface array that contains descriptions of the gateway network interfaces.

    • (dict) --

      Describes a gateway's network interface.

      • Ipv4Address (string) --

        The Internet Protocol version 4 (IPv4) address of the interface.

      • MacAddress (string) --

        The Media Access Control (MAC) address of the interface.

      • Ipv6Address (string) --

        The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

  • GatewayType (string) --

    The type of the gateway.

  • NextUpdateAvailabilityDate (string) --

    The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

  • LastSoftwareUpdate (string) --

    The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.