Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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.

post/#X-Amz-Target=StorageGateway_20130630.CreateTapePool

Headers

X-Amz-Target'StorageGateway_20130630.CreateTapePool' required

Request body

PoolNamestring required

The name of the new custom tape pool.

StorageClass'DEEP_ARCHIVE' | 'GLACIER' 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'COMPLIANCE' | 'GOVERNANCE' | 'NONE'

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.

RetentionLockTimeInDaysinteger

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

Response

Success

PoolARNstring

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