Skip to main content

Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateTapeWithBarcodeCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { StorageGatewayClient, CreateTapeWithBarcodeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, CreateTapeWithBarcodeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // CreateTapeWithBarcodeInput
  GatewayARN: "STRING_VALUE", // required
  TapeSizeInBytes: Number("long"), // required
  TapeBarcode: "STRING_VALUE", // required
  KMSEncrypted: true || false,
  KMSKey: "STRING_VALUE",
  PoolId: "STRING_VALUE",
  Worm: true || false,
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateTapeWithBarcodeCommand(input);
const response = await client.send(command);
// { // CreateTapeWithBarcodeOutput
//   TapeARN: "STRING_VALUE",
// };

Example Usage

Loading code editor

CreateTapeWithBarcodeCommand Input

See CreateTapeWithBarcodeCommandInput for more details

Parameter	Type	Description
`GatewayARN` Required	`string \| undefined`	The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
`TapeBarcode` Required	`string \| undefined`	The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
`TapeSizeInBytes` Required	`number \| undefined`	The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (102410241024 bytes).
`KMSEncrypted`	`boolean \| undefined`	Set to `true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3. Optional. Valid Values: `true` \| `false`
`KMSKey`	`string \| undefined`	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.
`PoolId`	`string \| undefined`	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.
`Tags`	`Tag[] \| undefined`	A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
`Worm`	`boolean \| undefined`	Set to `TRUE` if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

CreateTapeWithBarcodeCommand Output

See CreateTapeWithBarcodeCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`TapeARN`	`string \| undefined`	A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

Throws

Name	Fault	Details
InternalServerError	server	An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException	client	An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
StorageGatewayServiceException		Base exception class for all service exceptions from StorageGateway service.