feat(client-workspaces-web): Add support for toolbar configuration un…

…der user settings.
aws · Feb 20, 2025 · 4b613e3 · 4b613e3
1 parent a5e8b89
commit 4b613e3
Show file tree

Hide file tree

Showing 7 changed files with 332 additions and 0 deletions.
diff --git a/clients/client-workspaces-web/src/commands/CreateUserSettingsCommand.ts b/clients/client-workspaces-web/src/commands/CreateUserSettingsCommand.ts
@@ -77,6 +77,14 @@ export interface CreateUserSettingsCommandOutput extends CreateUserSettingsRespo
  *     "<keys>": "STRING_VALUE",
  *   },
  *   deepLinkAllowed: "STRING_VALUE",
+ *   toolbarConfiguration: { // ToolbarConfiguration
+ *     toolbarType: "STRING_VALUE",
+ *     visualMode: "STRING_VALUE",
+ *     hiddenToolbarItems: [ // HiddenToolbarItemList
+ *       "STRING_VALUE",
+ *     ],
+ *     maxDisplayResolution: "STRING_VALUE",
+ *   },
  * };
  * const command = new CreateUserSettingsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-workspaces-web/src/commands/GetUserSettingsCommand.ts b/clients/client-workspaces-web/src/commands/GetUserSettingsCommand.ts
@@ -78,6 +78,14 @@ export interface GetUserSettingsCommandOutput extends GetUserSettingsResponse, _
  * //       "<keys>": "STRING_VALUE",
  * //     },
  * //     deepLinkAllowed: "STRING_VALUE",
+ * //     toolbarConfiguration: { // ToolbarConfiguration
+ * //       toolbarType: "STRING_VALUE",
+ * //       visualMode: "STRING_VALUE",
+ * //       hiddenToolbarItems: [ // HiddenToolbarItemList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       maxDisplayResolution: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-workspaces-web/src/commands/ListUserSettingsCommand.ts b/clients/client-workspaces-web/src/commands/ListUserSettingsCommand.ts
@@ -73,6 +73,14 @@ export interface ListUserSettingsCommandOutput extends ListUserSettingsResponse,
  * //         ],
  * //       },
  * //       deepLinkAllowed: "STRING_VALUE",
+ * //       toolbarConfiguration: { // ToolbarConfiguration
+ * //         toolbarType: "STRING_VALUE",
+ * //         visualMode: "STRING_VALUE",
+ * //         hiddenToolbarItems: [ // HiddenToolbarItemList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         maxDisplayResolution: "STRING_VALUE",
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-workspaces-web/src/commands/UpdateUserSettingsCommand.ts b/clients/client-workspaces-web/src/commands/UpdateUserSettingsCommand.ts
@@ -67,6 +67,14 @@ export interface UpdateUserSettingsCommandOutput extends UpdateUserSettingsRespo
  *     ],
  *   },
  *   deepLinkAllowed: "STRING_VALUE",
+ *   toolbarConfiguration: { // ToolbarConfiguration
+ *     toolbarType: "STRING_VALUE",
+ *     visualMode: "STRING_VALUE",
+ *     hiddenToolbarItems: [ // HiddenToolbarItemList
+ *       "STRING_VALUE",
+ *     ],
+ *     maxDisplayResolution: "STRING_VALUE",
+ *   },
  * };
  * const command = new UpdateUserSettingsCommand(input);
  * const response = await client.send(command);
@@ -104,6 +112,14 @@ export interface UpdateUserSettingsCommandOutput extends UpdateUserSettingsRespo
  * //       "<keys>": "STRING_VALUE",
  * //     },
  * //     deepLinkAllowed: "STRING_VALUE",
+ * //     toolbarConfiguration: { // ToolbarConfiguration
+ * //       toolbarType: "STRING_VALUE",
+ * //       visualMode: "STRING_VALUE",
+ * //       hiddenToolbarItems: [ // HiddenToolbarItemList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       maxDisplayResolution: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-workspaces-web/src/models/models_0.ts b/clients/client-workspaces-web/src/models/models_0.ts
@@ -4090,6 +4090,101 @@ export const EnabledType = {
  */
 export type EnabledType = (typeof EnabledType)[keyof typeof EnabledType];
 
+/**
+ * @public
+ * @enum
+ */
+export const ToolbarItem = {
+  DUAL_MONITOR: "DualMonitor",
+  FULL_SCREEN: "FullScreen",
+  MICROPHONE: "Microphone",
+  WEBCAM: "Webcam",
+  WINDOWS: "Windows",
+} as const;
+
+/**
+ * @public
+ */
+export type ToolbarItem = (typeof ToolbarItem)[keyof typeof ToolbarItem];
+
+/**
+ * @public
+ * @enum
+ */
+export const MaxDisplayResolution = {
+  RESOLUTION_1080P: "size1920X1080",
+  RESOLUTION_1440P: "size2560X1440",
+  RESOLUTION_1440P_ULTRA_WIDE: "size3440X1440",
+  RESOLUTION_600P: "size800X600",
+  RESOLUTION_720P: "size1280X720",
+  RESOLUTION_768P: "size1024X768",
+  RESOLUTION_DCI_4K: "size4096X2160",
+  RESOLUTION_UHD_4K: "size3840X2160",
+} as const;
+
+/**
+ * @public
+ */
+export type MaxDisplayResolution = (typeof MaxDisplayResolution)[keyof typeof MaxDisplayResolution];
+
+/**
+ * @public
+ * @enum
+ */
+export const ToolbarType = {
+  DOCKED: "Docked",
+  FLOATING: "Floating",
+} as const;
+
+/**
+ * @public
+ */
+export type ToolbarType = (typeof ToolbarType)[keyof typeof ToolbarType];
+
+/**
+ * @public
+ * @enum
+ */
+export const VisualMode = {
+  DARK: "Dark",
+  LIGHT: "Light",
+} as const;
+
+/**
+ * @public
+ */
+export type VisualMode = (typeof VisualMode)[keyof typeof VisualMode];
+
+/**
+ * <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
+ * @public
+ */
+export interface ToolbarConfiguration {
+  /**
+   * <p>The type of toolbar displayed during the session.</p>
+   * @public
+   */
+  toolbarType?: ToolbarType | undefined;
+
+  /**
+   * <p>The visual mode of the toolbar.</p>
+   * @public
+   */
+  visualMode?: VisualMode | undefined;
+
+  /**
+   * <p>The list of toolbar items to be hidden.</p>
+   * @public
+   */
+  hiddenToolbarItems?: ToolbarItem[] | undefined;
+
+  /**
+   * <p>The maximum display resolution that is allowed for the session.</p>
+   * @public
+   */
+  maxDisplayResolution?: MaxDisplayResolution | undefined;
+}
+
 /**
  * @public
  */
@@ -4185,6 +4280,12 @@ export interface CreateUserSettingsRequest {
    * @public
    */
   deepLinkAllowed?: EnabledType | undefined;
+
+  /**
+   * <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
+   * @public
+   */
+  toolbarConfiguration?: ToolbarConfiguration | undefined;
 }
 
 /**
@@ -4318,6 +4419,12 @@ export interface UserSettings {
    * @public
    */
   deepLinkAllowed?: EnabledType | undefined;
+
+  /**
+   * <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
+   * @public
+   */
+  toolbarConfiguration?: ToolbarConfiguration | undefined;
 }
 
 /**
@@ -4421,6 +4528,12 @@ export interface UserSettingsSummary {
    * @public
    */
   deepLinkAllowed?: EnabledType | undefined;
+
+  /**
+   * <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
+   * @public
+   */
+  toolbarConfiguration?: ToolbarConfiguration | undefined;
 }
 
 /**
@@ -4524,6 +4637,12 @@ export interface UpdateUserSettingsRequest {
    * @public
    */
   deepLinkAllowed?: EnabledType | undefined;
+
+  /**
+   * <p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>
+   * @public
+   */
+  toolbarConfiguration?: ToolbarConfiguration | undefined;
 }
 
 /**

diff --git a/clients/client-workspaces-web/src/protocols/Aws_restJson1.ts b/clients/client-workspaces-web/src/protocols/Aws_restJson1.ts
@@ -257,6 +257,8 @@ import {
   SessionSummary,
   Tag,
   ThrottlingException,
+  ToolbarConfiguration,
+  ToolbarItem,
   TooManyTagsException,
   ValidationException,
 } from "../models/models_0";
@@ -634,6 +636,7 @@ export const se_CreateUserSettingsCommand = async (
       pasteAllowed: [],
       printAllowed: [],
       tags: (_) => _json(_),
+      toolbarConfiguration: (_) => _json(_),
       uploadAllowed: [],
     })
   );
@@ -1628,6 +1631,7 @@ export const se_UpdateUserSettingsCommand = async (
       idleDisconnectTimeoutInMinutes: [],
       pasteAllowed: [],
       printAllowed: [],
+      toolbarConfiguration: (_) => _json(_),
       uploadAllowed: [],
     })
   );
@@ -3247,6 +3251,8 @@ const se_CertificateList = (input: Uint8Array[], context: __SerdeContext): any =
 
 // se_GlobalInlineRedactionUrls omitted.
 
+// se_HiddenToolbarItemList omitted.
+
 // se_IdentityProviderDetails omitted.
 
 // se_InlineRedactionConfiguration omitted.
@@ -3271,6 +3277,8 @@ const se_CertificateList = (input: Uint8Array[], context: __SerdeContext): any =
 
 // se_TagList omitted.
 
+// se_ToolbarConfiguration omitted.
+
 // de_ArnList omitted.
 
 // de_BrowserSettings omitted.
@@ -3370,6 +3378,8 @@ const de_DataProtectionSettingsSummary = (output: any, context: __SerdeContext):
 
 // de_GlobalInlineRedactionUrls omitted.
 
+// de_HiddenToolbarItemList omitted.
+
 // de_IdentityProvider omitted.
 
 // de_IdentityProviderDetails omitted.
@@ -3554,6 +3564,8 @@ const de_SessionSummaryList = (output: any, context: __SerdeContext): SessionSum
 
 // de_TagList omitted.
 
+// de_ToolbarConfiguration omitted.
+
 // de_TrustStore omitted.
 
 // de_TrustStoreSummary omitted.