Amazon Storage Gateway Detach Volume Input Structure

AttachVolumeInput

Type: object Properties: 2 Required: 1

BackupFile StorageGatewayHybrid CloudStorage

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

Properties

VolumeARN ForceDetach

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

JSON Structure

{
  "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-detach-volume-input-structure.json",
  "name": "DetachVolumeInput",
  "description": "AttachVolumeInput",
  "properties": {
    "VolumeARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the volume to detach from the gateway."
        }
      ]
    },
    "ForceDetach": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "<p>Set to <code>true</code> to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is <code>false</code>. If this value is set to <code>false</code>, you must manually disconnect the iSCSI connection from the target volume.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>"
        }
      ]
    }
  },
  "required": [
    "VolumeARN"
  ]
}