AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

Tape

Describes a virtual tape object.

Contents

KMSKey

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 2048.

Required: No

PoolId

The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

Valid values: "GLACIER", "DEEP_ARCHIVE"

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

Progress

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

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

Type: Double

Required: No

TapeARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{7,16}$

Required: No

TapeBarcode

The barcode that identifies a specific virtual tape.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 16.

Pattern: ^[A-Z0-9]*$

Required: No

TapeCreatedDate

The date the virtual tape was created.

Type: Timestamp

Required: No

TapeSizeInBytes

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

Type: Long

Required: No

TapeStatus

The current state of the virtual tape.

Type: String

Required: No

TapeUsedInBytes

The size, in bytes, of data stored on the virtual tape.

Note

This value is not available for tapes created prior to May 13, 2015.

Type: Long

Required: No

VTLDevice

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: