StorageGateway / Client / assign_tape_pool

assign_tape_pool#

StorageGateway.Client.assign_tape_pool(**kwargs)#

Assigns a tape to a tape pool for archiving. The tape assigned to a 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 S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

See also: AWS API Documentation

Request Syntax

response = client.assign_tape_pool(
    TapeARN='string',
    PoolId='string',
    BypassGovernanceRetention=True|False
)
Parameters:

  • TapeARN (string) –

    [REQUIRED]

    The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.

  • 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 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.

  • BypassGovernanceRetention (boolean) –

    Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape’s archived age is not older than RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.

    Valid values: TRUE | FALSE

Return type:

dict

Returns:

Response Syntax

{
    'TapeARN': 'string'
}

Response Structure

  • (dict) –

    • TapeARN (string) –

      The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError