feat(client-cloudtrail): This release introduces new APIs for creatin…

…g and managing CloudTrail Lake dashboards. It also adds support for resource-based policies on CloudTrail EventDataStore and Dashboard resource.
aws · Nov 21, 2024 · 72fc499 · 72fc499
1 parent 6eede48
commit 72fc499
Show file tree

Hide file tree

Showing 40 changed files with 3,449 additions and 220 deletions.
diff --git a/clients/client-cloudtrail/README.md b/clients/client-cloudtrail/README.md
@@ -242,6 +242,14 @@ CreateChannel
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/CreateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/CreateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/CreateChannelCommandOutput/)
 
+</details>
+<details>
+<summary>
+CreateDashboard
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/CreateDashboardCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/CreateDashboardCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/CreateDashboardCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -266,6 +274,14 @@ DeleteChannel
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/DeleteChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/DeleteChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/DeleteChannelCommandOutput/)
 
+</details>
+<details>
+<summary>
+DeleteDashboard
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/DeleteDashboardCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/DeleteDashboardCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/DeleteDashboardCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -346,6 +362,14 @@ GetChannel
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/GetChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/GetChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/GetChannelCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetDashboard
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/GetDashboardCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/GetDashboardCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/GetDashboardCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -418,6 +442,14 @@ ListChannels
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/ListChannelsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/ListChannelsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/ListChannelsCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListDashboards
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/ListDashboardsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/ListDashboardsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/ListDashboardsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -538,6 +570,14 @@ RestoreEventDataStore
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/RestoreEventDataStoreCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/RestoreEventDataStoreCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/RestoreEventDataStoreCommandOutput/)
 
+</details>
+<details>
+<summary>
+StartDashboardRefresh
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/StartDashboardRefreshCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/StartDashboardRefreshCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/StartDashboardRefreshCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -602,6 +642,14 @@ UpdateChannel
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/UpdateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/UpdateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/UpdateChannelCommandOutput/)
 
+</details>
+<details>
+<summary>
+UpdateDashboard
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudtrail/command/UpdateDashboardCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/UpdateDashboardCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudtrail/Interface/UpdateDashboardCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-cloudtrail/src/CloudTrail.ts b/clients/client-cloudtrail/src/CloudTrail.ts
@@ -10,6 +10,11 @@ import {
   CreateChannelCommandInput,
   CreateChannelCommandOutput,
 } from "./commands/CreateChannelCommand";
+import {
+  CreateDashboardCommand,
+  CreateDashboardCommandInput,
+  CreateDashboardCommandOutput,
+} from "./commands/CreateDashboardCommand";
 import {
   CreateEventDataStoreCommand,
   CreateEventDataStoreCommandInput,
@@ -21,6 +26,11 @@ import {
   DeleteChannelCommandInput,
   DeleteChannelCommandOutput,
 } from "./commands/DeleteChannelCommand";
+import {
+  DeleteDashboardCommand,
+  DeleteDashboardCommandInput,
+  DeleteDashboardCommandOutput,
+} from "./commands/DeleteDashboardCommand";
 import {
   DeleteEventDataStoreCommand,
   DeleteEventDataStoreCommandInput,
@@ -63,6 +73,11 @@ import {
   GenerateQueryCommandOutput,
 } from "./commands/GenerateQueryCommand";
 import { GetChannelCommand, GetChannelCommandInput, GetChannelCommandOutput } from "./commands/GetChannelCommand";
+import {
+  GetDashboardCommand,
+  GetDashboardCommandInput,
+  GetDashboardCommandOutput,
+} from "./commands/GetDashboardCommand";
 import {
   GetEventDataStoreCommand,
   GetEventDataStoreCommandInput,
@@ -100,6 +115,11 @@ import {
   ListChannelsCommandInput,
   ListChannelsCommandOutput,
 } from "./commands/ListChannelsCommand";
+import {
+  ListDashboardsCommand,
+  ListDashboardsCommandInput,
+  ListDashboardsCommandOutput,
+} from "./commands/ListDashboardsCommand";
 import {
   ListEventDataStoresCommand,
   ListEventDataStoresCommandInput,
@@ -155,6 +175,11 @@ import {
   RestoreEventDataStoreCommandInput,
   RestoreEventDataStoreCommandOutput,
 } from "./commands/RestoreEventDataStoreCommand";
+import {
+  StartDashboardRefreshCommand,
+  StartDashboardRefreshCommandInput,
+  StartDashboardRefreshCommandOutput,
+} from "./commands/StartDashboardRefreshCommand";
 import {
   StartEventDataStoreIngestionCommand,
   StartEventDataStoreIngestionCommandInput,
@@ -179,6 +204,11 @@ import {
   UpdateChannelCommandInput,
   UpdateChannelCommandOutput,
 } from "./commands/UpdateChannelCommand";
+import {
+  UpdateDashboardCommand,
+  UpdateDashboardCommandInput,
+  UpdateDashboardCommandOutput,
+} from "./commands/UpdateDashboardCommand";
 import {
   UpdateEventDataStoreCommand,
   UpdateEventDataStoreCommandInput,
@@ -190,9 +220,11 @@ const commands = {
   AddTagsCommand,
   CancelQueryCommand,
   CreateChannelCommand,
+  CreateDashboardCommand,
   CreateEventDataStoreCommand,
   CreateTrailCommand,
   DeleteChannelCommand,
+  DeleteDashboardCommand,
   DeleteEventDataStoreCommand,
   DeleteResourcePolicyCommand,
   DeleteTrailCommand,
@@ -203,6 +235,7 @@ const commands = {
   EnableFederationCommand,
   GenerateQueryCommand,
   GetChannelCommand,
+  GetDashboardCommand,
   GetEventDataStoreCommand,
   GetEventSelectorsCommand,
   GetImportCommand,
@@ -212,6 +245,7 @@ const commands = {
   GetTrailCommand,
   GetTrailStatusCommand,
   ListChannelsCommand,
+  ListDashboardsCommand,
   ListEventDataStoresCommand,
   ListImportFailuresCommand,
   ListImportsCommand,
@@ -227,6 +261,7 @@ const commands = {
   RegisterOrganizationDelegatedAdminCommand,
   RemoveTagsCommand,
   RestoreEventDataStoreCommand,
+  StartDashboardRefreshCommand,
   StartEventDataStoreIngestionCommand,
   StartImportCommand,
   StartLoggingCommand,
@@ -235,6 +270,7 @@ const commands = {
   StopImportCommand,
   StopLoggingCommand,
   UpdateChannelCommand,
+  UpdateDashboardCommand,
   UpdateEventDataStoreCommand,
   UpdateTrailCommand,
 };
@@ -273,6 +309,20 @@ export interface CloudTrail {
     cb: (err: any, data?: CreateChannelCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CreateDashboardCommand}
+   */
+  createDashboard(
+    args: CreateDashboardCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CreateDashboardCommandOutput>;
+  createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
+  createDashboard(
+    args: CreateDashboardCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CreateDashboardCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateEventDataStoreCommand}
    */
@@ -312,6 +362,20 @@ export interface CloudTrail {
     cb: (err: any, data?: DeleteChannelCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteDashboardCommand}
+   */
+  deleteDashboard(
+    args: DeleteDashboardCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteDashboardCommandOutput>;
+  deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
+  deleteDashboard(
+    args: DeleteDashboardCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteDashboardCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteEventDataStoreCommand}
    */
@@ -457,6 +521,17 @@ export interface CloudTrail {
     cb: (err: any, data?: GetChannelCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetDashboardCommand}
+   */
+  getDashboard(args: GetDashboardCommandInput, options?: __HttpHandlerOptions): Promise<GetDashboardCommandOutput>;
+  getDashboard(args: GetDashboardCommandInput, cb: (err: any, data?: GetDashboardCommandOutput) => void): void;
+  getDashboard(
+    args: GetDashboardCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetDashboardCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetEventDataStoreCommand}
    */
@@ -588,6 +663,21 @@ export interface CloudTrail {
     cb: (err: any, data?: ListChannelsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListDashboardsCommand}
+   */
+  listDashboards(): Promise<ListDashboardsCommandOutput>;
+  listDashboards(
+    args: ListDashboardsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListDashboardsCommandOutput>;
+  listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
+  listDashboards(
+    args: ListDashboardsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListDashboardsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListEventDataStoresCommand}
    */
@@ -809,6 +899,23 @@ export interface CloudTrail {
     cb: (err: any, data?: RestoreEventDataStoreCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StartDashboardRefreshCommand}
+   */
+  startDashboardRefresh(
+    args: StartDashboardRefreshCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StartDashboardRefreshCommandOutput>;
+  startDashboardRefresh(
+    args: StartDashboardRefreshCommandInput,
+    cb: (err: any, data?: StartDashboardRefreshCommandOutput) => void
+  ): void;
+  startDashboardRefresh(
+    args: StartDashboardRefreshCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StartDashboardRefreshCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link StartEventDataStoreIngestionCommand}
    */
@@ -911,6 +1018,20 @@ export interface CloudTrail {
     cb: (err: any, data?: UpdateChannelCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateDashboardCommand}
+   */
+  updateDashboard(
+    args: UpdateDashboardCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateDashboardCommandOutput>;
+  updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
+  updateDashboard(
+    args: UpdateDashboardCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateDashboardCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateEventDataStoreCommand}
    */