ListCacheReportsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { StorageGatewayClient, ListCacheReportsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, ListCacheReportsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // ListCacheReportsInput
  Marker: "STRING_VALUE",
};
const command = new ListCacheReportsCommand(input);
const response = await client.send(command);
// { // ListCacheReportsOutput
//   CacheReportList: [ // CacheReportList
//     { // CacheReportInfo
//       CacheReportARN: "STRING_VALUE",
//       CacheReportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELED" || "FAILED" || "ERROR",
//       ReportCompletionPercent: Number("int"),
//       EndTime: new Date("TIMESTAMP"),
//       Role: "STRING_VALUE",
//       FileShareARN: "STRING_VALUE",
//       LocationARN: "STRING_VALUE",
//       StartTime: new Date("TIMESTAMP"),
//       InclusionFilters: [ // CacheReportFilterList
//         { // CacheReportFilter
//           Name: "UploadState" || "UploadFailureReason", // required
//           Values: [ // CacheReportFilterValues // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       ExclusionFilters: [
//         {
//           Name: "UploadState" || "UploadFailureReason", // required
//           Values: [ // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       ReportName: "STRING_VALUE",
//       Tags: [ // Tags
//         { // Tag
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//         },
//       ],
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

ListCacheReportsCommand Input

See ListCacheReportsCommandInput for more details

Parameter
Type
Description
Marker
string | undefined

Opaque pagination token returned from a previous ListCacheReports operation. If present, Marker specifies where to continue the list from after a previous call to ListCacheReports. Optional.

ListCacheReportsCommand Output

See ListCacheReportsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CacheReportList
CacheReportInfo[] | undefined

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 status, completion progress, start time, end time, filters, and tags.

Marker
string | undefined

If the request includes Marker, the response returns that value in this field.

Throws

Name
Fault
Details
InternalServerError
server

An internal server error has occurred during the request. For more information, see the error and message fields.

InvalidGatewayRequestException
client

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

StorageGatewayServiceException
Base exception class for all service exceptions from StorageGateway service.