CancelCacheReportCommand

Suggest an Edit

Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.

Example Syntax

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

import { StorageGatewayClient, CancelCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, CancelCacheReportCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // CancelCacheReportInput
  CacheReportARN: "STRING_VALUE", // required
};
const command = new CancelCacheReportCommand(input);
const response = await client.send(command);
// { // CancelCacheReportOutput
//   CacheReportARN: "STRING_VALUE",
// };

CancelCacheReportCommand Input

See CancelCacheReportCommandInput for more details

Parameter
Type
Description
CacheReportARN
Required
string | undefined

The Amazon Resource Name (ARN) of the cache report you want to cancel.

CancelCacheReportCommand Output

See CancelCacheReportCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CacheReportARN
string | undefined

The Amazon Resource Name (ARN) of the cache report you want to cancel.

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.