tape_archives

Creates, updates, deletes, gets or lists a tape_archives resource.

Overview

Name	tape_archives
Type	Resource
Id	aws.storagegateway.tape_archives

Fields

The following fields are returned by SELECT queries:

describe_tape_archives

Name	Datatype	Description
completion_time	string (date-time)	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.
kms_key	string	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. (pattern: <code>(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)</code>)
pool_entry_date	string (date-time)	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.
pool_id	string	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.
retention_start_date	string (date-time)	If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
retrieved_to	string	The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
tape_arn	string	The Amazon Resource Name (ARN) of an archived virtual tape. (pattern: <code>arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):storagegateway:[a-z-0-9]+:[0-9]+:tape/[0-9A-Z]{5,16}$</code>)
tape_barcode	string	The barcode that identifies the archived virtual tape. (pattern: <code>^[A-Z0-9]*$</code>)
tape_created_date	string (date-time)	The date the virtual tape was created.
tape_size_in_bytes	integer (int64)	The size, in bytes, of the archived virtual tape.
tape_status	string	The current state of the archived virtual tape.
tape_used_in_bytes	integer (int64)	The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015.
worm	boolean	Set to true if the archived tape is stored as write-once-read-many (WORM).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_tape_archives	select	region		Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
delete_tape_archive	delete	region		Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_tape_archives

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

SELECT
completion_time,
kms_key,
pool_entry_date,
pool_id,
retention_start_date,
retrieved_to,
tape_arn,
tape_barcode,
tape_created_date,
tape_size_in_bytes,
tape_status,
tape_used_in_bytes,
worm
FROM aws.storagegateway.tape_archives
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_tape_archive

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

DELETE FROM aws.storagegateway.tape_archives
WHERE region = '{{ region }}' --required
;