StorageGateway / Client / create_tape_with_barcode

create_tape_with_barcode#

StorageGateway.Client.create_tape_with_barcode(**kwargs)#

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.create_tape_with_barcode(
    GatewayARN='string',
    TapeSizeInBytes=123,
    TapeBarcode='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 tape 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 tape that you want to create.

    Note

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

  • TapeBarcode (string) –

    [REQUIRED]

    The barcode that you want to assign to the tape.

    Note

    Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

  • 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 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 that has a barcode. 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

{
    'TapeARN': 'string'
}

Response Structure

  • (dict) –

    CreateTapeOutput

    • TapeARN (string) –

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

Exceptions

Examples

Creates a virtual tape by using your own barcode.

response = client.create_tape_with_barcode(
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    TapeBarcode='TEST12345',
    TapeSizeInBytes=107374182400,
)

print(response)

Expected Output:

{
    'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345',
    'ResponseMetadata': {
        '...': '...',
    },
}