@aws-sdk/client-workspaces-web 3.857.0 → 3.859.0

package/dist-types/commands/AssociateSessionLoggerCommand.d.ts

@@ -0,0 +1,109 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { AssociateSessionLoggerRequest, AssociateSessionLoggerResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link AssociateSessionLoggerCommand}.
+ */
+export interface AssociateSessionLoggerCommandInput extends AssociateSessionLoggerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link AssociateSessionLoggerCommand}.
+ */
+export interface AssociateSessionLoggerCommandOutput extends AssociateSessionLoggerResponse, __MetadataBearer {
+}
+declare const AssociateSessionLoggerCommand_base: {
+    new (input: AssociateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateSessionLoggerCommandInput, AssociateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: AssociateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateSessionLoggerCommandInput, AssociateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Associates a session logger with a portal.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, AssociateSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, AssociateSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // AssociateSessionLoggerRequest
+ *   portalArn: "STRING_VALUE", // required
+ *   sessionLoggerArn: "STRING_VALUE", // required
+ * };
+ * const command = new AssociateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * // { // AssociateSessionLoggerResponse
+ * //   portalArn: "STRING_VALUE", // required
+ * //   sessionLoggerArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param AssociateSessionLoggerCommandInput - {@link AssociateSessionLoggerCommandInput}
+ * @returns {@link AssociateSessionLoggerCommandOutput}
+ * @see {@link AssociateSessionLoggerCommandInput} for command's `input` shape.
+ * @see {@link AssociateSessionLoggerCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ *
+ * @example Associate Session Logger with Portal
+ * ```javascript
+ * // Associates a session logger with a portal
+ * const input = {
+ *   portalArn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012",
+ *   sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111"
+ * };
+ * const command = new AssociateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   portalArn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012",
+ *   sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class AssociateSessionLoggerCommand extends AssociateSessionLoggerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AssociateSessionLoggerRequest;
+            output: AssociateSessionLoggerResponse;
+        };
+        sdk: {
+            input: AssociateSessionLoggerCommandInput;
+            output: AssociateSessionLoggerCommandOutput;
+        };
+    };
+}

package/dist-types/commands/CreateSessionLoggerCommand.d.ts

@@ -0,0 +1,189 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CreateSessionLoggerRequest, CreateSessionLoggerResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateSessionLoggerCommand}.
+ */
+export interface CreateSessionLoggerCommandInput extends CreateSessionLoggerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateSessionLoggerCommand}.
+ */
+export interface CreateSessionLoggerCommandOutput extends CreateSessionLoggerResponse, __MetadataBearer {
+}
+declare const CreateSessionLoggerCommand_base: {
+    new (input: CreateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSessionLoggerCommandInput, CreateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSessionLoggerCommandInput, CreateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a session logger.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, CreateSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, CreateSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // CreateSessionLoggerRequest
+ *   eventFilter: { // EventFilter Union: only one key present
+ *     all: {},
+ *     include: [ // Events
+ *       "WebsiteInteract" || "FileDownloadFromSecureBrowserToRemoteDisk" || "FileTransferFromRemoteToLocalDisk" || "FileTransferFromLocalToRemoteDisk" || "FileUploadFromRemoteDiskToSecureBrowser" || "ContentPasteToWebsite" || "ContentTransferFromLocalToRemoteClipboard" || "ContentCopyFromWebsite" || "UrlLoad" || "TabOpen" || "TabClose" || "PrintJobSubmit" || "SessionConnect" || "SessionStart" || "SessionDisconnect" || "SessionEnd",
+ *     ],
+ *   },
+ *   logConfiguration: { // LogConfiguration
+ *     s3: { // S3LogConfiguration
+ *       bucket: "STRING_VALUE", // required
+ *       keyPrefix: "STRING_VALUE",
+ *       bucketOwner: "STRING_VALUE",
+ *       logFileFormat: "JSONLines" || "Json", // required
+ *       folderStructure: "Flat" || "NestedByDate", // required
+ *     },
+ *   },
+ *   displayName: "STRING_VALUE",
+ *   customerManagedKey: "STRING_VALUE",
+ *   additionalEncryptionContext: { // EncryptionContextMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateSessionLoggerResponse
+ * //   sessionLoggerArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateSessionLoggerCommandInput - {@link CreateSessionLoggerCommandInput}
+ * @returns {@link CreateSessionLoggerCommandOutput}
+ * @see {@link CreateSessionLoggerCommandInput} for command's `input` shape.
+ * @see {@link CreateSessionLoggerCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The service quota has been exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ *
+ * @example Create Session Logger with All Events
+ * ```javascript
+ * // Creates a session logger that captures all events and stores them in S3 with JSON format and flat folder structure
+ * const input = {
+ *   displayName: "Session Logger with All Events",
+ *   eventFilter: {
+ *     all:     { /* empty *\/ }
+ *   },
+ *   logConfiguration: {
+ *     s3: {
+ *       bucket: "my-session-logs-bucket",
+ *       bucketOwner: "123456789012",
+ *       folderStructure: "Flat",
+ *       keyPrefix: "session-logs/all/events",
+ *       logFileFormat: "Json"
+ *     }
+ *   }
+ * };
+ * const command = new CreateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Create Session Logger with Specific Events
+ * ```javascript
+ * // Creates a session logger that captures only specific events with JSONLines format and nested folder structure
+ * const input = {
+ *   additionalEncryptionContext: {
+ *     EncryptionContextKey: "EncryptionContextValue"
+ *   },
+ *   customerManagedKey: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012",
+ *   displayName: "Session Logger with Each Events",
+ *   eventFilter: {
+ *     include: [
+ *       "SessionStart",
+ *       "SessionEnd",
+ *       "UrlLoad",
+ *       "WebsiteInteract"
+ *     ]
+ *   },
+ *   logConfiguration: {
+ *     s3: {
+ *       bucket: "my-session-logs-bucket",
+ *       bucketOwner: "123456789012",
+ *       folderStructure: "NestedByDate",
+ *       keyPrefix: "session-logs/each/event",
+ *       logFileFormat: "JSONLines"
+ *     }
+ *   },
+ *   tags: [
+ *     {
+ *       Key: "KEY-1",
+ *       Value: "VALUE-1"
+ *     },
+ *     {
+ *       Key: "KEY-2",
+ *       Value: "VALUE-2"
+ *     }
+ *   ]
+ * };
+ * const command = new CreateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateSessionLoggerCommand extends CreateSessionLoggerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateSessionLoggerRequest;
+            output: CreateSessionLoggerResponse;
+        };
+        sdk: {
+            input: CreateSessionLoggerCommandInput;
+            output: CreateSessionLoggerCommandOutput;
+        };
+    };
+}

package/dist-types/commands/DeleteSessionLoggerCommand.d.ts

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DeleteSessionLoggerRequest, DeleteSessionLoggerResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteSessionLoggerCommand}.
+ */
+export interface DeleteSessionLoggerCommandInput extends DeleteSessionLoggerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteSessionLoggerCommand}.
+ */
+export interface DeleteSessionLoggerCommandOutput extends DeleteSessionLoggerResponse, __MetadataBearer {
+}
+declare const DeleteSessionLoggerCommand_base: {
+    new (input: DeleteSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSessionLoggerCommandInput, DeleteSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DeleteSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSessionLoggerCommandInput, DeleteSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a session logger resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, DeleteSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, DeleteSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // DeleteSessionLoggerRequest
+ *   sessionLoggerArn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteSessionLoggerCommandInput - {@link DeleteSessionLoggerCommandInput}
+ * @returns {@link DeleteSessionLoggerCommandOutput}
+ * @see {@link DeleteSessionLoggerCommandInput} for command's `input` shape.
+ * @see {@link DeleteSessionLoggerCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ *
+ * @example Delete Session Logger
+ * ```javascript
+ * // Deletes a session logger resource
+ * const input = {
+ *   sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
+ * };
+ * const command = new DeleteSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class DeleteSessionLoggerCommand extends DeleteSessionLoggerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteSessionLoggerRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteSessionLoggerCommandInput;
+            output: DeleteSessionLoggerCommandOutput;
+        };
+    };
+}

package/dist-types/commands/DisassociateSessionLoggerCommand.d.ts

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DisassociateSessionLoggerRequest, DisassociateSessionLoggerResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DisassociateSessionLoggerCommand}.
+ */
+export interface DisassociateSessionLoggerCommandInput extends DisassociateSessionLoggerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DisassociateSessionLoggerCommand}.
+ */
+export interface DisassociateSessionLoggerCommandOutput extends DisassociateSessionLoggerResponse, __MetadataBearer {
+}
+declare const DisassociateSessionLoggerCommand_base: {
+    new (input: DisassociateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateSessionLoggerCommandInput, DisassociateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DisassociateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateSessionLoggerCommandInput, DisassociateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Disassociates a session logger from a portal.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkSpacesWebClient, DisassociateSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
+ * // const { WorkSpacesWebClient, DisassociateSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
+ * const client = new WorkSpacesWebClient(config);
+ * const input = { // DisassociateSessionLoggerRequest
+ *   portalArn: "STRING_VALUE", // required
+ * };
+ * const command = new DisassociateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DisassociateSessionLoggerCommandInput - {@link DisassociateSessionLoggerCommandInput}
+ * @returns {@link DisassociateSessionLoggerCommandOutput}
+ * @see {@link DisassociateSessionLoggerCommandInput} for command's `input` shape.
+ * @see {@link DisassociateSessionLoggerCommandOutput} for command's `response` shape.
+ * @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There is an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>There is a throttling error.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There is a validation error.</p>
+ *
+ * @throws {@link WorkSpacesWebServiceException}
+ * <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
+ *
+ *
+ * @example Disassociate Session Logger from Portal
+ * ```javascript
+ * // Removes the association between a session logger and a portal
+ * const input = {
+ *   portalArn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012"
+ * };
+ * const command = new DisassociateSessionLoggerCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class DisassociateSessionLoggerCommand extends DisassociateSessionLoggerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DisassociateSessionLoggerRequest;
+            output: {};
+        };
+        sdk: {
+            input: DisassociateSessionLoggerCommandInput;
+            output: DisassociateSessionLoggerCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetPortalCommand.d.ts

@@ -52,6 +52,7 @@ declare const GetPortalCommand_base: {
  * //     dataProtectionSettingsArn: "STRING_VALUE",
  * //     userSettingsArn: "STRING_VALUE",
  * //     networkSettingsArn: "STRING_VALUE",
+ * //     sessionLoggerArn: "STRING_VALUE",
  * //     trustStoreArn: "STRING_VALUE",
  * //     statusReason: "STRING_VALUE",
  * //     userAccessLoggingSettingsArn: "STRING_VALUE",