# CreateTapes
<a name="API_CreateTapes"></a>

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.

**Note**  
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the [AddCache](API_AddCache.md) operation to add cache storage to a gateway.

## Request Syntax
<a name="API_CreateTapes_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "GatewayARN": "string",
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NumTapesToCreate": number,
   "PoolId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TapeBarcodePrefix": "string",
   "TapeSizeInBytes": number,
   "Worm": boolean
}
```

## Request Parameters
<a name="API_CreateTapes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-ClientToken"></a>
A unique identifier that you use to retry a request. If you retry a request, use the same `ClientToken` you specified in the initial request.  
Using the same `ClientToken` prevents creating the tape multiple times.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [GatewayARN](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-GatewayARN"></a>
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [KMSEncrypted](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-KMSEncrypted"></a>
Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-KMSKey"></a>
The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. 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

 ** [NumTapesToCreate](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-NumTapesToCreate"></a>
The number of virtual tapes that you want to create.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: Yes

 ** [PoolId](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-PoolId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Tags](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-Tags"></a>
A list of up to 50 tags that can be assigned to a virtual tape. 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: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TapeBarcodePrefix](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-TapeBarcodePrefix"></a>
A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.  
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `^[A-Z]*$`   
Required: Yes

 ** [TapeSizeInBytes](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tapes that you want to create.  
The size must be aligned by gigabyte (1024\$11024\$11024 bytes).
Type: Long  
Required: Yes

 ** [Worm](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-Worm"></a>
Set to `TRUE` if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateTapes_ResponseSyntax"></a>

```
{
   "TapeARNs": [ "string" ]
}
```

## Response Elements
<a name="API_CreateTapes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARNs](#API_CreateTapes_ResponseSyntax) **   <a name="StorageGateway-CreateTapes-response-TapeARNs"></a>
A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.  
Type: Array of strings  
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}$` 

## Errors
<a name="API_CreateTapes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateTapes_Examples"></a>

### Create tapes in a tape gateway
<a name="API_CreateTapes_Example_1"></a>

In the following request, you add three virtual tape cartridges, 100 GB each in size, to the tape gateway with the ID sgw-12A3456B. The tapes appear in the gateway's virtual tape library. In the request, you set the tape's barcode prefix to "TEST".

#### Sample Request
<a name="API_CreateTapes_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "TapeSizeInBytes": "107374182400",
    "ClientToken": "77777",
    "NumTapesToCreate": "3",
    "PooId": "Deep_Archive",
    "TapeBarcodePrefix": "TEST"
}
```

#### Sample Response
<a name="API_CreateTapes_Example_1_Response"></a>

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

## See Also
<a name="API_CreateTapes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateTapes)