StorageGateway / Client / create_tapes

create_tapes

StorageGateway.Client.create_tapes(**kwargs)

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 operation to add cache storage to a gateway.

See also: AWS API Documentation

Request Syntax

response = client.create_tapes(
    GatewayARN='string',
    TapeSizeInBytes=123,
    ClientToken='string',
    NumTapesToCreate=123,
    TapeBarcodePrefix='string',
    KMSEncrypted=True|False,
    KMSKey='string',
    PoolId='string',
    Worm=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• GatewayARN (string) –

  [REQUIRED]

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

• TapeSizeInBytes (integer) –

  [REQUIRED]

  The size, in bytes, of the virtual tapes that you want to create.

  Note

  The size must be aligned by gigabyte (1024*1024*1024 bytes).

• ClientToken (string) –

  [REQUIRED]

  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.

  Note

  Using the same ClientToken prevents creating the tape multiple times.

• NumTapesToCreate (integer) –

  [REQUIRED]

  The number of virtual tapes that you want to create.

• TapeBarcodePrefix (string) –

  [REQUIRED]

  A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

  Note

  The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

• KMSEncrypted (boolean) –

  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) – 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) – 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.

• Worm (boolean) – Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

• Tags (list) –

  A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.

  Note

  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.

  • (dict) –

    A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

    • Key (string) – [REQUIRED]

      Tag key. The key can’t start with aws:.

    • Value (string) – [REQUIRED]

      Value of the tag key.

Return type:

dict

Returns:

Response Syntax

{
    'TapeARNs': [
        'string',
    ]
}

Response Structure

• (dict) –

  CreateTapeOutput

  • TapeARNs (list) –

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

    • (string) –

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException

• StorageGateway.Client.exceptions.InternalServerError

Examples

Creates one or more virtual tapes.

response = client.create_tapes(
    ClientToken='77777',
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    NumTapesToCreate=3,
    TapeBarcodePrefix='TEST',
    TapeSizeInBytes=107374182400,
)

print(response)

Expected Output:

{
    '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',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}