StorageGateway / Paginator / DescribeVTLDevices

DescribeVTLDevices

class StorageGateway.Paginator.DescribeVTLDevices

paginator = client.get_paginator('describe_vtl_devices')

paginate(**kwargs)

Creates an iterator that will paginate through responses from StorageGateway.Client.describe_vtl_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GatewayARN='string',
    VTLDeviceARNs=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GatewayARN (string) –

  [REQUIRED]

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

• VTLDeviceARNs (list) –

  An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

  Note

  All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'VTLDevices': [
        {
            'VTLDeviceARN': 'string',
            'VTLDeviceType': 'string',
            'VTLDeviceVendor': 'string',
            'VTLDeviceProductIdentifier': 'string',
            'DeviceiSCSIAttributes': {
                'TargetARN': 'string',
                'NetworkInterfaceId': 'string',
                'NetworkInterfacePort': 123,
                'ChapEnabled': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  DescribeVTLDevicesOutput

  • GatewayARN (string) –

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

  • VTLDevices (list) –

    An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.

    • (dict) –

      Represents a device object associated with a tape gateway.

      • VTLDeviceARN (string) –

        Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

      • VTLDeviceType (string) –

        Specifies the type of device that the VTL device emulates.

      • VTLDeviceVendor (string) –

        Specifies the vendor of the device that the VTL device object emulates.

      • VTLDeviceProductIdentifier (string) –

        Specifies the model number of device that the VTL device emulates.

      • DeviceiSCSIAttributes (dict) –

        A list of iSCSI information about a VTL device.

        • TargetARN (string) –

          Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

        • NetworkInterfaceId (string) –

          The network interface identifier of the VTL device.

        • NetworkInterfacePort (integer) –

          The port used to communicate with iSCSI VTL device targets.

        • ChapEnabled (boolean) –

          Indicates whether mutual CHAP is enabled for the iSCSI target.

  • NextToken (string) –

    A token to resume pagination.