Amazon Storage Gateway Delete File Share Input Structure

DeleteFileShareInput

Type: object Properties: 2 Required: 1

BackupFile StorageGatewayHybrid CloudStorage

DeleteFileShareInput 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

FileShareARN ForceDelete

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-delete-file-share-input-structure.json",
  "name": "DeleteFileShareInput",
  "description": "DeleteFileShareInput",
  "properties": {
    "FileShareARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileShareARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the file share to be deleted."
        }
      ]
    },
    "ForceDelete": {
      "allOf": [
        {
          "$ref": "#/components/schemas/boolean"
        },
        {
          "description": "<p>If this value is set to <code>true</code>, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the <code>FORCE_DELETING</code> status.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>"
        }
      ]
    }
  },
  "required": [
    "FileShareARN"
  ]
}