AWS Storage Gateway

{'FolderList': ['string'], 'Recursive': 'boolean'}

{'NotificationId': 'string'}

Refreshes the cache 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 is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.

See also: AWS API Documentation

Request Syntax

client.refresh_cache(
    FileShareARN='string',
    FolderList=[
        'string',
    ],
    Recursive=True|False
)

type FileShareARN

string

param FileShareARN

[REQUIRED]

The Amazon Resource Name (ARN) of the file share.

type FolderList

list

param 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.

• (string) --

type Recursive

boolean

param 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".

rtype

dict

returns

Response Syntax

{
    'FileShareARN': 'string',
    'NotificationId': 'string'
}

Response Structure

• (dict) --

  RefreshCacheOutput

  • FileShareARN (string) --

    The Amazon Resource Name (ARN) of the file share.

  • NotificationId (string) --

    The randomly generated ID of the notification that was sent. This ID is in UUID format.