AWS Storage Gateway

{'TapeArchives': {'TapeUsedInBytes': 'long'}}

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

See also: AWS API Documentation

Request Syntax

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

type TapeARNs:

list

param TapeARNs:

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

• (string) --

type Marker:

string

param Marker:

An opaque string that indicates the position at which to begin describing virtual tapes.

type Limit:

integer

param Limit:

Specifies that the number of virtual tapes descried be limited to the specified number.

rtype:

dict

returns:

Response Syntax

{
    'TapeArchives': [
        {
            'TapeARN': 'string',
            'TapeBarcode': 'string',
            'TapeCreatedDate': datetime(2015, 1, 1),
            'TapeSizeInBytes': 123,
            'CompletionTime': datetime(2015, 1, 1),
            'RetrievedTo': 'string',
            'TapeStatus': 'string',
            'TapeUsedInBytes': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  DescribeTapeArchivesOutput

  • TapeArchives (list) --

    An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

    • (dict) --

      Represents a virtual tape that is archived in the virtual tape shelf (VTS).

      • TapeARN (string) --

        The Amazon Resource Name (ARN) of an archived virtual tape.

      • TapeBarcode (string) --

        The barcode that identifies the archived virtual tape.

      • TapeCreatedDate (datetime) --

      • TapeSizeInBytes (integer) --

        The size, in bytes, of the archived virtual tape.

      • CompletionTime (datetime) --

        The time that the archiving of the virtual tape was completed.

        The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

      • RetrievedTo (string) --

        The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

        The virtual tape is retrieved from the virtual tape shelf (VTS).

      • TapeStatus (string) --

        The current state of the archived virtual tape.

      • TapeUsedInBytes (integer) --

        The size, in bytes, of data written to the virtual tape.

  • Marker (string) --

    An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

{'Tapes': {'TapeUsedInBytes': 'long'}}

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway architecture.

See also: AWS API Documentation

Request Syntax

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

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 TapeARNs:

list

param TapeARNs:

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

• (string) --

type Marker:

string

param Marker:

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

type Limit:

integer

param Limit:

Specifies that the number of virtual tapes described be limited to the specified number.

rtype:

dict

returns:

Response Syntax

{
    'Tapes': [
        {
            'TapeARN': 'string',
            'TapeBarcode': 'string',
            'TapeCreatedDate': datetime(2015, 1, 1),
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string',
            'VTLDevice': 'string',
            'Progress': 123.0,
            'TapeUsedInBytes': 123
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  DescribeTapesOutput

  • Tapes (list) --

    An array of virtual tape descriptions.

    • (dict) --

      Describes a virtual tape object.

      • TapeARN (string) --

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

      • TapeBarcode (string) --

        The barcode that identifies a specific virtual tape.

      • TapeCreatedDate (datetime) --

        The date the virtual tape was created.

      • TapeSizeInBytes (integer) --

        The size, in bytes, of the virtual tape capacity.

      • TapeStatus (string) --

        The current state of the virtual tape.

      • VTLDevice (string) --

        The virtual tape library (VTL) device that the virtual tape is associated with.

      • Progress (float) --

        For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

        Range: 0 (not started) to 100 (complete).

      • TapeUsedInBytes (integer) --

        The size, in bytes, of data written to the virtual tape.

  • Marker (string) --

    An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

    If a response does not contain a marker, then there are no more results to be retrieved.