Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Create Snapshot Input Structure

A JSON object containing one or more of the following fields:

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

CreateSnapshotInput 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

VolumeARN SnapshotDescription Tags

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-create-snapshot-input-structure.json",
  "name": "CreateSnapshotInput",
  "description": "<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>CreateSnapshotInput$SnapshotDescription</a> </p> </li> <li> <p> <a>CreateSnapshotInput$VolumeARN</a> </p> </li> </ul>",
  "properties": {
    "VolumeARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes."
        }
      ]
    },
    "SnapshotDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SnapshotDescription"
        },
        {
          "description": "Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "<p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</p> <note> <p>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.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "VolumeARN",
    "SnapshotDescription"
  ]
}