AWS Storage Gateway

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes.

Request Syntax

client.list_tapes(
    TapeARNs=[
        'string',
    ],
    Marker='string',
    Limit=123
)

type TapeARNs

list

param TapeARNs

The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.

• (string) --

type Marker

string

param Marker

A string that indicates the position at which to begin the returned list of tapes.

type Limit

integer

param Limit

An optional number limit for the tapes in the list returned by this call.

rtype

dict

returns

Response Syntax

{
    'TapeInfos': [
        {
            'TapeARN': 'string',
            'TapeBarcode': 'string',
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string',
            'GatewayARN': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the following fields:

  • ListTapesOutput$Marker

  • ListTapesOutput$VolumeInfos

  • TapeInfos (list) --

    An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.

    • (dict) --

      Describes a virtual tape.

      • TapeARN (string) --

        The Amazon Resource Name (ARN) of a virtual tape.

      • TapeBarcode (string) --

        The barcode that identifies a specific virtual tape.

      • TapeSizeInBytes (integer) --

        The size, in bytes, of a virtual tape.

      • TapeStatus (string) --

        The status of the tape.

      • 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.

  • Marker (string) --

    A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

{'Gateways': {'GatewayId': 'string'}}

Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Request Syntax

client.list_gateways(
    Marker='string',
    Limit=123
)

type Marker

string

param Marker

An opaque string that indicates the position at which to begin the returned list of gateways.

type Limit

integer

param Limit

Specifies that the list of gateways returned be limited to the specified number of items.

rtype

dict

returns

Response Syntax

{
    'Gateways': [
        {
            'GatewayId': 'string',
            'GatewayARN': 'string',
            'GatewayType': 'string',
            'GatewayOperationalState': 'string',
            'GatewayName': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  • Gateways (list) --

    • (dict) --

      Describes a gateway object.

      • GatewayId (string) --

        The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

      • 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.

      • GatewayType (string) --

        The type of the gateway.

      • GatewayOperationalState (string) --

        The state of the gateway.

        Valid Values: DISABLED or ACTIVE

      • GatewayName (string) --

        The name of the gateway.

  • Marker (string) --

{'VolumeInfos': {'GatewayARN': 'string',
                 'GatewayId': 'string',
                 'VolumeId': 'string',
                 'VolumeSizeInBytes': 'long'}}

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.

Request Syntax

client.list_volumes(
    GatewayARN='string',
    Marker='string',
    Limit=123
)

type GatewayARN

string

param GatewayARN

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

type Marker

string

param Marker

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

type Limit

integer

param Limit

Specifies that the list of volumes returned be limited to the specified number of items.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string',
    'Marker': 'string',
    'VolumeInfos': [
        {
            'VolumeARN': 'string',
            'VolumeId': 'string',
            'GatewayARN': 'string',
            'GatewayId': 'string',
            'VolumeType': 'string',
            'VolumeSizeInBytes': 123
        },
    ]
}

Response Structure

• (dict) --

  • 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.

  • Marker (string) --

  • VolumeInfos (list) --

    • (dict) --

      Describes a storage volume object.

      • VolumeARN (string) --

        The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

        arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

        Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

      • VolumeId (string) --

        The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

        Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

      • 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 unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

        Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

      • VolumeType (string) --

      • VolumeSizeInBytes (integer) --

        The size, in bytes, of the volume.

        Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).