StorageGateway / Client / update_automatic_tape_creation_policy

update_automatic_tape_creation_policy#

StorageGateway.Client.update_automatic_tape_creation_policy(**kwargs)#

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

By default, there is no automatic tape creation policy.

Note

A gateway can have only one automatic tape creation policy.

See also: AWS API Documentation

Request Syntax

response = client.update_automatic_tape_creation_policy(
    AutomaticTapeCreationRules=[
        {
            'TapeBarcodePrefix': 'string',
            'PoolId': 'string',
            'TapeSizeInBytes': 123,
            'MinimumNumTapes': 123,
            'Worm': True|False
        },
    ],
    GatewayARN='string'
)
Parameters:

  • AutomaticTapeCreationRules (list) –

    [REQUIRED]

    An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

    • (dict) –

      An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.

      • TapeBarcodePrefix (string) – [REQUIRED]

        A prefix that you append to the barcode of the virtual tape that 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.

      • PoolId (string) – [REQUIRED]

        The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon 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.

      • TapeSizeInBytes (integer) – [REQUIRED]

        The size, in bytes, of the virtual tape capacity.

      • MinimumNumTapes (integer) – [REQUIRED]

        The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.

      • Worm (boolean) –

        Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.

  • GatewayARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) –

    • GatewayARN (string) –

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Exceptions