Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Refresh Cache Input Structure

RefreshCacheInput

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

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

Properties

FileShareARN FolderList Recursive

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-refresh-cache-input-structure.json",
  "name": "RefreshCacheInput",
  "description": "RefreshCacheInput",
  "properties": {
    "FileShareARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileShareARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the file share you want to refresh."
        }
      ]
    },
    "FolderList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FolderList"
        },
        {
          "description": "A comma-separated list of the paths of folders to refresh in the cache. The default is [<code>\"/\"</code>]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If <code>Recursive</code> is set to <code>true</code>, the entire S3 bucket that the file share has access to is refreshed."
        }
      ]
    },
    "Recursive": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "<p>A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to <code>true</code>, each folder that is listed in <code>FolderList</code> is recursively updated. Otherwise, subfolders listed in <code>FolderList</code> are not refreshed. Only objects that are in folders listed directly under <code>FolderList</code> are found and used for the update. The default is <code>true</code>.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>"
        }
      ]
    }
  },
  "required": [
    "FileShareARN"
  ]
}