Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

post/#X-Amz-Target=StorageGateway_20130630.CreateTapeWithBarcode

Headers

X-Amz-Target'StorageGateway_20130630.CreateTapeWithBarcode' required

Request body

GatewayARNstring required

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

TapeSizeInBytesinteger required
<p>The size, in bytes, of the virtual tape that you want to create.</p> <note> <p>The size must be aligned by gigabyte (1024*1024*1024 bytes).</p> </note>
TapeBarcodestring required
<p>The barcode that you want to assign to the tape.</p> <note> <p>Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.</p> </note>
KMSEncryptedboolean
<p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key, or <code>false</code> to use a key managed by Amazon S3. Optional.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>
KMSKeystring

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 <code>KMSEncrypted</code> is <code>true</code>. Optional.

PoolIdstring

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is 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 Deep Archive) that corresponds to the pool.

Wormboolean

Set to <code>TRUE</code> if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

Response

Success

TapeARNstring

A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

Example response

{
  "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
}