storagegateway_start_cache_report {paws.storage} | R Documentation |
Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share
Description
Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request.
See https://www.paws-r-sdk.com/docs/storagegateway_start_cache_report/ for full documentation.
Usage
storagegateway_start_cache_report(
FileShareARN,
Role,
LocationARN,
BucketRegion,
VPCEndpointDNSName = NULL,
InclusionFilters = NULL,
ExclusionFilters = NULL,
ClientToken,
Tags = NULL
)
Arguments
FileShareARN |
[required] |
Role |
[required] The ARN of the IAM role used when saving the cache report to Amazon S3. |
LocationARN |
[required] The ARN of the Amazon S3 bucket where the cache report will be saved. We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report. This field does not accept access point ARNs. |
BucketRegion |
[required] The Amazon Web Services Region of the Amazon S3 bucket associated with the file share for which you want to generate the cache report. |
VPCEndpointDNSName |
The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional. |
InclusionFilters |
The list of filters and parameters that determine which files are
included in the report. You must specify at least one value for
|
ExclusionFilters |
The list of filters and parameters that determine which files are
excluded from the report. You must specify at least one value for
|
ClientToken |
[required] A unique identifier that you use to ensure idempotent report generation
if you need to retry an unsuccessful
|
Tags |
A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results. |