CreateTapePool - AWS Storage Gateway Service

CreateTapePool

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.

Request Syntax

{ "PoolName": "string", "RetentionLockTimeInDays": number, "RetentionLockType": "string", "StorageClass": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

PoolName

The name of the new custom tape pool.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Required: Yes

RetentionLockTimeInDays

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 36500.

Required: No

RetentionLockType

Tape retention lock can be configured in two modes. When configured in governance mode, AWS 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 AWS account.

Type: String

Valid Values: COMPLIANCE | GOVERNANCE | NONE

Required: No

StorageClass

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.

Type: String

Valid Values: DEEP_ARCHIVE | GLACIER

Required: Yes

Tags

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.

Type: Array of Tag objects

Required: No

Response Syntax

{ "PoolARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PoolARN

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 AWS Region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: