CacheReportInfo
Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.
Contents
- CacheReportARN
-
The Amazon Resource Name (ARN) of the cache report you want to describe.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: No
- CacheReportStatus
-
The status of the specified cache report.
Type: String
Valid Values:
IN_PROGRESS | COMPLETED | CANCELED | FAILED | ERRORRequired: No
- EndTime
-
The time at which the gateway stopped generating the cache report.
Type: Timestamp
Required: No
- ExclusionFilters
-
The list of filters and parameters that determine which files are excluded from the report.
Type: Array of CacheReportFilter objects
Required: No
-
The Amazon Resource Name (ARN) of the file share.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: No
- InclusionFilters
-
The list of filters and parameters that determine which files are included in the report.
Type: Array of CacheReportFilter objects
Required: No
- LocationARN
-
The ARN of the Amazon S3 bucket location where the cache report is saved.
Type: String
Length Constraints: Minimum length of 16. Maximum length of 1400.
Required: No
- ReportCompletionPercent
-
The percentage of the report generation process that has been completed at time of inquiry.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- ReportName
-
The file name of the completed cache report object stored in Amazon S3.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- Role
-
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$Required: No
- StartTime
-
The time at which the gateway started generating the cache report.
Type: Timestamp
Required: No
- Tags
-
The list of key/value tags associated with the report.
Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
