Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

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

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

Headers

X-Amz-Target'StorageGateway_20130630.CreateTapes' required

Request body

GatewayARNstring required

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes 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 tapes that you want to create.</p> <note> <p>The size must be aligned by gigabyte (1024*1024*1024 bytes).</p> </note>
ClientTokenstring required
<p>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request.</p> <note> <p>Using the same <code>ClientToken</code> prevents creating the tape multiple times.</p> </note>
NumTapesToCreateinteger required

The number of virtual tapes that you want to create.

TapeBarcodePrefixstring required
<p>A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.</p> <note> <p>The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.</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 Glacier 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

TapeARNsTapeARN[]

A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.

Example response

{
  "TapeARNs": [
    "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D",
    "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F",
    "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E"
  ]
}