feat(client-storage-gateway): This release adds support for generatin…

…g cache reports on S3 File Gateways for files that fail to upload.
aws · Feb 13, 2025 · aeef69f · aeef69f
1 parent 8983d46
commit aeef69f
Show file tree

Hide file tree

Showing 13 changed files with 1,958 additions and 7 deletions.
diff --git a/clients/client-storage-gateway/README.md b/clients/client-storage-gateway/README.md
@@ -338,6 +338,14 @@ CancelArchival
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/CancelArchivalCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/CancelArchivalCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/CancelArchivalCommandOutput/)
 
+</details>
+<details>
+<summary>
+CancelCacheReport
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/CancelCacheReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/CancelCacheReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/CancelCacheReportCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -434,6 +442,14 @@ DeleteBandwidthRateLimit
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/DeleteBandwidthRateLimitCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DeleteBandwidthRateLimitCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DeleteBandwidthRateLimitCommandOutput/)
 
+</details>
+<details>
+<summary>
+DeleteCacheReport
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/DeleteCacheReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DeleteCacheReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DeleteCacheReportCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -538,6 +554,14 @@ DescribeCachediSCSIVolumes
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/DescribeCachediSCSIVolumesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DescribeCachediSCSIVolumesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DescribeCachediSCSIVolumesCommandOutput/)
 
+</details>
+<details>
+<summary>
+DescribeCacheReport
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/DescribeCacheReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DescribeCacheReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/DescribeCacheReportCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -698,6 +722,14 @@ ListAutomaticTapeCreationPolicies
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/ListAutomaticTapeCreationPoliciesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/ListAutomaticTapeCreationPoliciesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/ListAutomaticTapeCreationPoliciesCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListCacheReports
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/ListCacheReportsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/ListCacheReportsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/ListCacheReportsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -858,6 +890,14 @@ StartAvailabilityMonitorTest
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/StartAvailabilityMonitorTestCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/StartAvailabilityMonitorTestCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/StartAvailabilityMonitorTestCommandOutput/)
 
+</details>
+<details>
+<summary>
+StartCacheReport
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/storage-gateway/command/StartCacheReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/StartCacheReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-storage-gateway/Interface/StartCacheReportCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-storage-gateway/src/StorageGateway.ts b/clients/client-storage-gateway/src/StorageGateway.ts
@@ -43,6 +43,11 @@ import {
   CancelArchivalCommandInput,
   CancelArchivalCommandOutput,
 } from "./commands/CancelArchivalCommand";
+import {
+  CancelCacheReportCommand,
+  CancelCacheReportCommandInput,
+  CancelCacheReportCommandOutput,
+} from "./commands/CancelCacheReportCommand";
 import {
   CancelRetrievalCommand,
   CancelRetrievalCommandInput,
@@ -99,6 +104,11 @@ import {
   DeleteBandwidthRateLimitCommandInput,
   DeleteBandwidthRateLimitCommandOutput,
 } from "./commands/DeleteBandwidthRateLimitCommand";
+import {
+  DeleteCacheReportCommand,
+  DeleteCacheReportCommandInput,
+  DeleteCacheReportCommandOutput,
+} from "./commands/DeleteCacheReportCommand";
 import {
   DeleteChapCredentialsCommand,
   DeleteChapCredentialsCommandInput,
@@ -160,6 +170,11 @@ import {
   DescribeCachediSCSIVolumesCommandInput,
   DescribeCachediSCSIVolumesCommandOutput,
 } from "./commands/DescribeCachediSCSIVolumesCommand";
+import {
+  DescribeCacheReportCommand,
+  DescribeCacheReportCommandInput,
+  DescribeCacheReportCommandOutput,
+} from "./commands/DescribeCacheReportCommand";
 import {
   DescribeChapCredentialsCommand,
   DescribeChapCredentialsCommandInput,
@@ -256,6 +271,11 @@ import {
   ListAutomaticTapeCreationPoliciesCommandInput,
   ListAutomaticTapeCreationPoliciesCommandOutput,
 } from "./commands/ListAutomaticTapeCreationPoliciesCommand";
+import {
+  ListCacheReportsCommand,
+  ListCacheReportsCommandInput,
+  ListCacheReportsCommandOutput,
+} from "./commands/ListCacheReportsCommand";
 import {
   ListFileSharesCommand,
   ListFileSharesCommandInput,
@@ -344,6 +364,11 @@ import {
   StartAvailabilityMonitorTestCommandInput,
   StartAvailabilityMonitorTestCommandOutput,
 } from "./commands/StartAvailabilityMonitorTestCommand";
+import {
+  StartCacheReportCommand,
+  StartCacheReportCommandInput,
+  StartCacheReportCommandOutput,
+} from "./commands/StartCacheReportCommand";
 import {
   StartGatewayCommand,
   StartGatewayCommandInput,
@@ -436,6 +461,7 @@ const commands = {
   AssociateFileSystemCommand,
   AttachVolumeCommand,
   CancelArchivalCommand,
+  CancelCacheReportCommand,
   CancelRetrievalCommand,
   CreateCachediSCSIVolumeCommand,
   CreateNFSFileShareCommand,
@@ -448,6 +474,7 @@ const commands = {
   CreateTapeWithBarcodeCommand,
   DeleteAutomaticTapeCreationPolicyCommand,
   DeleteBandwidthRateLimitCommand,
+  DeleteCacheReportCommand,
   DeleteChapCredentialsCommand,
   DeleteFileShareCommand,
   DeleteGatewayCommand,
@@ -461,6 +488,7 @@ const commands = {
   DescribeBandwidthRateLimitScheduleCommand,
   DescribeCacheCommand,
   DescribeCachediSCSIVolumesCommand,
+  DescribeCacheReportCommand,
   DescribeChapCredentialsCommand,
   DescribeFileSystemAssociationsCommand,
   DescribeGatewayInformationCommand,
@@ -481,6 +509,7 @@ const commands = {
   DisassociateFileSystemCommand,
   JoinDomainCommand,
   ListAutomaticTapeCreationPoliciesCommand,
+  ListCacheReportsCommand,
   ListFileSharesCommand,
   ListFileSystemAssociationsCommand,
   ListGatewaysCommand,
@@ -501,6 +530,7 @@ const commands = {
   SetSMBGuestPasswordCommand,
   ShutdownGatewayCommand,
   StartAvailabilityMonitorTestCommand,
+  StartCacheReportCommand,
   StartGatewayCommand,
   UpdateAutomaticTapeCreationPolicyCommand,
   UpdateBandwidthRateLimitCommand,
@@ -649,6 +679,23 @@ export interface StorageGateway {
     cb: (err: any, data?: CancelArchivalCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CancelCacheReportCommand}
+   */
+  cancelCacheReport(
+    args: CancelCacheReportCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CancelCacheReportCommandOutput>;
+  cancelCacheReport(
+    args: CancelCacheReportCommandInput,
+    cb: (err: any, data?: CancelCacheReportCommandOutput) => void
+  ): void;
+  cancelCacheReport(
+    args: CancelCacheReportCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CancelCacheReportCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CancelRetrievalCommand}
    */
@@ -838,6 +885,23 @@ export interface StorageGateway {
     cb: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteCacheReportCommand}
+   */
+  deleteCacheReport(
+    args: DeleteCacheReportCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteCacheReportCommandOutput>;
+  deleteCacheReport(
+    args: DeleteCacheReportCommandInput,
+    cb: (err: any, data?: DeleteCacheReportCommandOutput) => void
+  ): void;
+  deleteCacheReport(
+    args: DeleteCacheReportCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteCacheReportCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteChapCredentialsCommand}
    */
@@ -1029,6 +1093,23 @@ export interface StorageGateway {
     cb: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeCacheReportCommand}
+   */
+  describeCacheReport(
+    args: DescribeCacheReportCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeCacheReportCommandOutput>;
+  describeCacheReport(
+    args: DescribeCacheReportCommandInput,
+    cb: (err: any, data?: DescribeCacheReportCommandOutput) => void
+  ): void;
+  describeCacheReport(
+    args: DescribeCacheReportCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeCacheReportCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeChapCredentialsCommand}
    */
@@ -1350,6 +1431,24 @@ export interface StorageGateway {
     cb: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListCacheReportsCommand}
+   */
+  listCacheReports(): Promise<ListCacheReportsCommandOutput>;
+  listCacheReports(
+    args: ListCacheReportsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListCacheReportsCommandOutput>;
+  listCacheReports(
+    args: ListCacheReportsCommandInput,
+    cb: (err: any, data?: ListCacheReportsCommandOutput) => void
+  ): void;
+  listCacheReports(
+    args: ListCacheReportsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListCacheReportsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListFileSharesCommand}
    */
@@ -1651,6 +1750,23 @@ export interface StorageGateway {
     cb: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StartCacheReportCommand}
+   */
+  startCacheReport(
+    args: StartCacheReportCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StartCacheReportCommandOutput>;
+  startCacheReport(
+    args: StartCacheReportCommandInput,
+    cb: (err: any, data?: StartCacheReportCommandOutput) => void
+  ): void;
+  startCacheReport(
+    args: StartCacheReportCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StartCacheReportCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link StartGatewayCommand}
    */