storagegateway_refresh_cache: Refreshes the cached inventory of objects for the specified...

View source: R/storagegateway_operations.R

storagegateway_refresh_cacheR Documentation

Refreshes the cached inventory of objects for the specified file share

Description

Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.

See https://www.paws-r-sdk.com/docs/storagegateway_refresh_cache/ for full documentation.

Usage

storagegateway_refresh_cache(FileShareARN, FolderList = NULL, Recursive = NULL)

Arguments

FileShareARN

[required] The Amazon Resource Name (ARN) of the file share you want to refresh.

FolderList

A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

Do not include / when specifying folder names. For example, you would specify samplefolder rather than ⁠samplefolder/⁠.

Recursive

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 true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false


paws.storage documentation built on Sept. 12, 2024, 6:16 a.m.