ListCacheReports
Returns a list of existing cache reports for all file shares associated with your
AWS 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.
Request Syntax
{
"Marker": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Marker
-
Opaque pagination token returned from a previous
ListCacheReportsoperation. If present,Markerspecifies where to continue the list from after a previous call toListCacheReports. Optional.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
Response Syntax
{
"CacheReportList": [
{
"CacheReportARN": "string",
"CacheReportStatus": "string",
"EndTime": number,
"ExclusionFilters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"FileShareARN": "string",
"InclusionFilters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"LocationARN": "string",
"ReportCompletionPercent": number,
"ReportName": "string",
"Role": "string",
"StartTime": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"Marker": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CacheReportList
-
A list of existing cache reports for all file shares associated with your AWS account. This list includes all information provided by the
DescribeCacheReportaction, such as report status, completion progress, start time, end time, filters, and tags.Type: Array of CacheReportInfo objects
- Marker
-
If the request includes
Marker, the response returns that value in this field.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
Examples
Get information about all cache reports
The following example gets information about all existing cache reports.
Sample Request
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListCacheReports
{}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80
{
"CacheReportList": [
{
"CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share-ABCD1234/cache-report/report-ABCD1234",
"CacheReportStatus": "COMPLETED",
"ReportCompletionPercent": 100,
"EndTime": "2025-02-11T21:32:09.535000+00:00",
"Role": "arn:aws:iam::123456789012:role/bucket-access-role",
"FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234",
"LocationARN": "arn:aws:s3:::bucket-bane",
"StartTime": "2025-02-11T21:31:42.081000+00:00",
"InclusionFilters": [
{
"Name": "UploadFailureReason",
"Values": [
"InaccessibleStorageClass",
"ObjectMissing"
]
}
],
"ReportName": "cache_report-ABCD1234_1739309502081.csv",
"Tags": []
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
