Tape - Storage Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Tape

Describes a virtual tape object.

Contents

KMSKey

Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

Type: String

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

Pattern: (^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)

Required: No

PoolEntryDate

The date that the tape enters a custom tape pool.

Type: Timestamp

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 (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

RetentionStartDate

The date that the tape is first archived with tape retention lock enabled.

Type: Timestamp

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(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$

Required: No

TapeBarcode

The barcode that identifies a specific virtual tape.

Type: String

Length Constraints: Minimum length of 5. 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

Worm

If the tape is archived as write-once-read-many (WORM), this value is true.

Type: Boolean

Required: No

See Also

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