Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Assign Tape Pool Input Structure

AssignTapePoolInput schema from Amazon Storage Gateway API

Type: object Properties: 3 Required: 2
BackupFile StorageGatewayHybrid CloudStorage

AssignTapePoolInput is a JSON Structure definition published by Amazon Storage Gateway, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

TapeARN PoolId BypassGovernanceRetention

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-structure/amazon-storage-gateway-assign-tape-pool-input-structure.json",
  "name": "AssignTapePoolInput",
  "description": "AssignTapePoolInput schema from Amazon Storage Gateway API",
  "properties": {
    "TapeARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeARN"
        },
        {
          "description": "The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool."
        }
      ]
    },
    "PoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PoolId"
        },
        {
          "description": "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/boolean"
        },
        {
          "description": "<p>Set permissions to bypass governance retention. If the lock type of the archived tape is <code>Governance</code>, the tape's archived age is not older than <code>RetentionLockInDays</code>, and the user does not already have <code>BypassGovernanceRetention</code>, 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.</p> <p>Valid values: <code>TRUE</code> | <code>FALSE</code> </p>"
        }
      ]
    }
  },
  "required": [
    "TapeARN",
    "PoolId"
  ]
}