TapeArchive - 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).

TapeArchive

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

Contents

CompletionTime

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

The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

Type: Timestamp

Required: No

KMSKey

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 can only be set when KMSEncrypted is true. Optional.

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 time that the tape entered the custom tape pool.

The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

Type: Timestamp

Required: No

PoolId

The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

Type: String

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

Required: No

RetentionStartDate

If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.

Type: Timestamp

Required: No

RetrievedTo

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

Type: String

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

Required: No

TapeARN

The Amazon Resource Name (ARN) of an archived 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 the archived 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 archived virtual tape.

Type: Long

Required: No

TapeStatus

The current state of the archived 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

Worm

Set to true if the archived tape is stored as write-once-read-many (WORM).

Type: Boolean

Required: No

See Also

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