StorageGateway / Client / create_tape_pool

create_tape_pool#

StorageGateway.Client.create_tape_pool(**kwargs)#

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

See also: AWS API Documentation

Request Syntax

response = client.create_tape_pool(
    PoolName='string',
    StorageClass='DEEP_ARCHIVE'|'GLACIER',
    RetentionLockType='COMPLIANCE'|'GOVERNANCE'|'NONE',
    RetentionLockTimeInDays=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • PoolName (string) –

    [REQUIRED]

    The name of the new custom tape pool.

  • StorageClass (string) –

    [REQUIRED]

    The storage class that is associated with the new custom 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.

  • RetentionLockType (string) – Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

  • RetentionLockTimeInDays (integer) – Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

  • Tags (list) –

    A list of up to 50 tags that can be assigned to tape pool. 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

{
    'PoolARN': 'string'
}

Response Structure

  • (dict) –

    • PoolARN (string) –

      The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and Amazon Web Services Region.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError