cache_reports

Creates, updates, deletes, gets or lists a cache_reports resource.

Overview

Name	cache_reports
Type	Resource
Id	aws.storagegateway.cache_reports

Fields

The following fields are returned by SELECT queries:

describe_cache_report

Name	Datatype	Description
cache_report_arn	string	The Amazon Resource Name (ARN) of the cache report you want to describe.
cache_report_status	string	The status of the specified cache report. (IN_PROGRESS, COMPLETED, CANCELED, FAILED, ERROR)
end_time	string (date-time)	The time at which the gateway stopped generating the cache report.
exclusion_filters	array	The list of filters and parameters that determine which files are excluded from the report.
file_share_arn	string	The Amazon Resource Name (ARN) of the file share.
inclusion_filters	array	The list of filters and parameters that determine which files are included in the report.
location_arn	string	The ARN of the Amazon S3 bucket location where the cache report is saved.
report_completion_percent	integer	The percentage of the report generation process that has been completed at time of inquiry.
report_name	string	The file name of the completed cache report object stored in Amazon S3.
role	string	The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage. (pattern: <code>^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):iam::([0-9]+):role/(\S+)$</code>)
start_time	string (date-time)	The time at which the gateway started generating the cache report.
tags	array	The list of key/value tags associated with the report.

list_cache_reports

Name	Datatype	Description
cache_report_arn	string	The Amazon Resource Name (ARN) of the cache report you want to describe.
cache_report_status	string	The status of the specified cache report. (IN_PROGRESS, COMPLETED, CANCELED, FAILED, ERROR)
end_time	string (date-time)	The time at which the gateway stopped generating the cache report.
exclusion_filters	array	The list of filters and parameters that determine which files are excluded from the report.
file_share_arn	string	The Amazon Resource Name (ARN) of the file share.
inclusion_filters	array	The list of filters and parameters that determine which files are included in the report.
location_arn	string	The ARN of the Amazon S3 bucket location where the cache report is saved.
report_completion_percent	integer	The percentage of the report generation process that has been completed at time of inquiry.
report_name	string	The file name of the completed cache report object stored in Amazon S3.
role	string	The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage. (pattern: <code>^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):iam::([0-9]+):role/(\S+)$</code>)
start_time	string (date-time)	The time at which the gateway started generating the cache report.
tags	array	The list of key/value tags associated with the report.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cache_report	select	region		Returns information about the specified cache report, including completion status and generation progress.
list_cache_reports	select	region		Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report name, status, completion progress, start time, end time, filters, and tags.
delete_cache_report	delete	region		Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_cache_report

Returns information about the specified cache report, including completion status and generation progress.

SELECT
cache_report_arn,
cache_report_status,
end_time,
exclusion_filters,
file_share_arn,
inclusion_filters,
location_arn,
report_completion_percent,
report_name,
role,
start_time,
tags
FROM aws.storagegateway.cache_reports
WHERE region = '{{ region }}' -- required
;

list_cache_reports

Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report name, status, completion progress, start time, end time, filters, and tags.

SELECT
cache_report_arn,
cache_report_status,
end_time,
exclusion_filters,
file_share_arn,
inclusion_filters,
location_arn,
report_completion_percent,
report_name,
role,
start_time,
tags
FROM aws.storagegateway.cache_reports
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_cache_report

Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.

DELETE FROM aws.storagegateway.cache_reports
WHERE region = '{{ region }}' --required
;