- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteCacheReportCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { StorageGatewayClient, DeleteCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, DeleteCacheReportCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // DeleteCacheReportInput
CacheReportARN: "STRING_VALUE", // required
};
const command = new DeleteCacheReportCommand(input);
const response = await client.send(command);
// { // DeleteCacheReportOutput
// CacheReportARN: "STRING_VALUE",
// };
DeleteCacheReportCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
CacheReportARNRequired | string | undefined | The Amazon Resource Name (ARN) of the cache report you want to delete. |
DeleteCacheReportCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
CacheReportARN | string | undefined | The Amazon Resource Name (ARN) of the cache report you want to delete. |
Throws
Name | Fault | Details |
|---|
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. |