@aws-sdk/client-workspaces-web 3.856.0 → 3.858.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/dist-cjs/index.js +450 -0
- package/dist-es/WorkSpacesWeb.js +14 -0
- package/dist-es/commands/AssociateSessionLoggerCommand.js +22 -0
- package/dist-es/commands/CreateSessionLoggerCommand.js +23 -0
- package/dist-es/commands/DeleteSessionLoggerCommand.js +22 -0
- package/dist-es/commands/DisassociateSessionLoggerCommand.js +22 -0
- package/dist-es/commands/GetSessionLoggerCommand.js +23 -0
- package/dist-es/commands/ListSessionLoggersCommand.js +23 -0
- package/dist-es/commands/UpdateSessionLoggerCommand.js +23 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +83 -0
- package/dist-es/pagination/ListSessionLoggersPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +210 -1
- package/dist-types/WorkSpacesWeb.d.ts +50 -0
- package/dist-types/WorkSpacesWebClient.d.ts +9 -2
- package/dist-types/commands/AssociateSessionLoggerCommand.d.ts +109 -0
- package/dist-types/commands/CreateSessionLoggerCommand.d.ts +189 -0
- package/dist-types/commands/DeleteSessionLoggerCommand.d.ts +98 -0
- package/dist-types/commands/DisassociateSessionLoggerCommand.d.ts +98 -0
- package/dist-types/commands/GetPortalCommand.d.ts +1 -0
- package/dist-types/commands/GetSessionLoggerCommand.d.ts +187 -0
- package/dist-types/commands/ListPortalsCommand.d.ts +1 -0
- package/dist-types/commands/ListSessionLoggersCommand.d.ts +175 -0
- package/dist-types/commands/UpdatePortalCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSessionLoggerCommand.d.ts +217 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +452 -0
- package/dist-types/pagination/ListSessionLoggersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/ts3.4/WorkSpacesWeb.d.ts +120 -0
- package/dist-types/ts3.4/WorkSpacesWebClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssociateSessionLoggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateSessionLoggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteSessionLoggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateSessionLoggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSessionLoggerCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListSessionLoggersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSessionLoggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +164 -0
- package/dist-types/ts3.4/pagination/ListSessionLoggersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
- package/package.json +11 -11
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetSessionLoggerRequest, GetSessionLoggerResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSessionLoggerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSessionLoggerCommandInput extends GetSessionLoggerRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSessionLoggerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSessionLoggerCommandOutput extends GetSessionLoggerResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetSessionLoggerCommand_base: {
|
|
25
|
+
new (input: GetSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionLoggerCommandInput, GetSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionLoggerCommandInput, GetSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets details about a specific session logger resource.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WorkSpacesWebClient, GetSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
|
|
35
|
+
* // const { WorkSpacesWebClient, GetSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
|
|
36
|
+
* const client = new WorkSpacesWebClient(config);
|
|
37
|
+
* const input = { // GetSessionLoggerRequest
|
|
38
|
+
* sessionLoggerArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetSessionLoggerCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetSessionLoggerResponse
|
|
43
|
+
* // sessionLogger: { // SessionLogger
|
|
44
|
+
* // sessionLoggerArn: "STRING_VALUE", // required
|
|
45
|
+
* // eventFilter: { // EventFilter Union: only one key present
|
|
46
|
+
* // all: {},
|
|
47
|
+
* // include: [ // Events
|
|
48
|
+
* // "WebsiteInteract" || "FileDownloadFromSecureBrowserToRemoteDisk" || "FileTransferFromRemoteToLocalDisk" || "FileTransferFromLocalToRemoteDisk" || "FileUploadFromRemoteDiskToSecureBrowser" || "ContentPasteToWebsite" || "ContentTransferFromLocalToRemoteClipboard" || "ContentCopyFromWebsite" || "UrlLoad" || "TabOpen" || "TabClose" || "PrintJobSubmit" || "SessionConnect" || "SessionStart" || "SessionDisconnect" || "SessionEnd",
|
|
49
|
+
* // ],
|
|
50
|
+
* // },
|
|
51
|
+
* // logConfiguration: { // LogConfiguration
|
|
52
|
+
* // s3: { // S3LogConfiguration
|
|
53
|
+
* // bucket: "STRING_VALUE", // required
|
|
54
|
+
* // keyPrefix: "STRING_VALUE",
|
|
55
|
+
* // bucketOwner: "STRING_VALUE",
|
|
56
|
+
* // logFileFormat: "JSONLines" || "Json", // required
|
|
57
|
+
* // folderStructure: "Flat" || "NestedByDate", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // customerManagedKey: "STRING_VALUE",
|
|
61
|
+
* // additionalEncryptionContext: { // EncryptionContextMap
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // associatedPortalArns: [ // ArnList
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // displayName: "STRING_VALUE",
|
|
68
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param GetSessionLoggerCommandInput - {@link GetSessionLoggerCommandInput}
|
|
75
|
+
* @returns {@link GetSessionLoggerCommandOutput}
|
|
76
|
+
* @see {@link GetSessionLoggerCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link GetSessionLoggerCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p>Access is denied.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerException} (server fault)
|
|
84
|
+
* <p>There is an internal server error.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The resource cannot be found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>There is a throttling error.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
* <p>There is a validation error.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link WorkSpacesWebServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @example Get Session Logger with All Events
|
|
100
|
+
* ```javascript
|
|
101
|
+
* // Retrieves a session logger configured for all events
|
|
102
|
+
* const input = {
|
|
103
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
|
|
104
|
+
* };
|
|
105
|
+
* const command = new GetSessionLoggerCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response is
|
|
108
|
+
* {
|
|
109
|
+
* sessionLogger: {
|
|
110
|
+
* associatedPortalArns: [
|
|
111
|
+
* "arn:aws:workspaces-web:us-west-2:123456789012:portal/87654321-4321-4321-4321-210987654321"
|
|
112
|
+
* ],
|
|
113
|
+
* creationDate: "2024-01-15T10:30:00Z",
|
|
114
|
+
* displayName: "Session Logger with All Events",
|
|
115
|
+
* eventFilter: {
|
|
116
|
+
* all: { /* empty *\/ }
|
|
117
|
+
* },
|
|
118
|
+
* logConfiguration: {
|
|
119
|
+
* s3: {
|
|
120
|
+
* bucket: "my-session-logs-bucket-1",
|
|
121
|
+
* bucketOwner: "123456789012",
|
|
122
|
+
* folderStructure: "Flat",
|
|
123
|
+
* keyPrefix: "session-logs/all/events",
|
|
124
|
+
* logFileFormat: "Json"
|
|
125
|
+
* }
|
|
126
|
+
* },
|
|
127
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
|
|
128
|
+
* }
|
|
129
|
+
* }
|
|
130
|
+
* *\/
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
133
|
+
* @example Get Session Logger with Specific Events
|
|
134
|
+
* ```javascript
|
|
135
|
+
* // Retrieves a session logger configured for specific events
|
|
136
|
+
* const input = {
|
|
137
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
|
|
138
|
+
* };
|
|
139
|
+
* const command = new GetSessionLoggerCommand(input);
|
|
140
|
+
* const response = await client.send(command);
|
|
141
|
+
* /* response is
|
|
142
|
+
* {
|
|
143
|
+
* sessionLogger: {
|
|
144
|
+
* additionalEncryptionContext: {
|
|
145
|
+
* EncryptionContextKey: "EncryptionContextValue"
|
|
146
|
+
* },
|
|
147
|
+
* creationDate: "2024-01-15T14:45:00Z",
|
|
148
|
+
* customerManagedKey: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012",
|
|
149
|
+
* displayName: "Session Logger with Each Events",
|
|
150
|
+
* eventFilter: {
|
|
151
|
+
* include: [
|
|
152
|
+
* "SessionStart",
|
|
153
|
+
* "SessionEnd",
|
|
154
|
+
* "UrlLoad",
|
|
155
|
+
* "WebsiteInteract"
|
|
156
|
+
* ]
|
|
157
|
+
* },
|
|
158
|
+
* logConfiguration: {
|
|
159
|
+
* s3: {
|
|
160
|
+
* bucket: "my-session-logs-bucket-2",
|
|
161
|
+
* bucketOwner: "123456789012",
|
|
162
|
+
* folderStructure: "NestedByDate",
|
|
163
|
+
* keyPrefix: "session-logs/each/event",
|
|
164
|
+
* logFileFormat: "JSONLines"
|
|
165
|
+
* }
|
|
166
|
+
* },
|
|
167
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
|
|
168
|
+
* }
|
|
169
|
+
* }
|
|
170
|
+
* *\/
|
|
171
|
+
* ```
|
|
172
|
+
*
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
export declare class GetSessionLoggerCommand extends GetSessionLoggerCommand_base {
|
|
176
|
+
/** @internal type navigation helper, not in runtime. */
|
|
177
|
+
protected static __types: {
|
|
178
|
+
api: {
|
|
179
|
+
input: GetSessionLoggerRequest;
|
|
180
|
+
output: GetSessionLoggerResponse;
|
|
181
|
+
};
|
|
182
|
+
sdk: {
|
|
183
|
+
input: GetSessionLoggerCommandInput;
|
|
184
|
+
output: GetSessionLoggerCommandOutput;
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
}
|
|
@@ -54,6 +54,7 @@ declare const ListPortalsCommand_base: {
|
|
|
54
54
|
* // dataProtectionSettingsArn: "STRING_VALUE",
|
|
55
55
|
* // userSettingsArn: "STRING_VALUE",
|
|
56
56
|
* // networkSettingsArn: "STRING_VALUE",
|
|
57
|
+
* // sessionLoggerArn: "STRING_VALUE",
|
|
57
58
|
* // trustStoreArn: "STRING_VALUE",
|
|
58
59
|
* // userAccessLoggingSettingsArn: "STRING_VALUE",
|
|
59
60
|
* // authenticationType: "STRING_VALUE",
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListSessionLoggersRequest, ListSessionLoggersResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListSessionLoggersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListSessionLoggersCommandInput extends ListSessionLoggersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListSessionLoggersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListSessionLoggersCommandOutput extends ListSessionLoggersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListSessionLoggersCommand_base: {
|
|
25
|
+
new (input: ListSessionLoggersCommandInput): import("@smithy/smithy-client").CommandImpl<ListSessionLoggersCommandInput, ListSessionLoggersCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListSessionLoggersCommandInput]): import("@smithy/smithy-client").CommandImpl<ListSessionLoggersCommandInput, ListSessionLoggersCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all available session logger resources.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WorkSpacesWebClient, ListSessionLoggersCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
|
|
35
|
+
* // const { WorkSpacesWebClient, ListSessionLoggersCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
|
|
36
|
+
* const client = new WorkSpacesWebClient(config);
|
|
37
|
+
* const input = { // ListSessionLoggersRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListSessionLoggersCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListSessionLoggersResponse
|
|
44
|
+
* // sessionLoggers: [ // SessionLoggerList
|
|
45
|
+
* // { // SessionLoggerSummary
|
|
46
|
+
* // sessionLoggerArn: "STRING_VALUE", // required
|
|
47
|
+
* // logConfiguration: { // LogConfiguration
|
|
48
|
+
* // s3: { // S3LogConfiguration
|
|
49
|
+
* // bucket: "STRING_VALUE", // required
|
|
50
|
+
* // keyPrefix: "STRING_VALUE",
|
|
51
|
+
* // bucketOwner: "STRING_VALUE",
|
|
52
|
+
* // logFileFormat: "JSONLines" || "Json", // required
|
|
53
|
+
* // folderStructure: "Flat" || "NestedByDate", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // },
|
|
56
|
+
* // displayName: "STRING_VALUE",
|
|
57
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // nextToken: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param ListSessionLoggersCommandInput - {@link ListSessionLoggersCommandInput}
|
|
66
|
+
* @returns {@link ListSessionLoggersCommandOutput}
|
|
67
|
+
* @see {@link ListSessionLoggersCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link ListSessionLoggersCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>Access is denied.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalServerException} (server fault)
|
|
75
|
+
* <p>There is an internal server error.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>There is a throttling error.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>There is a validation error.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link WorkSpacesWebServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @example List All Session Loggers
|
|
88
|
+
* ```javascript
|
|
89
|
+
* // Lists all session loggers in the account without pagination
|
|
90
|
+
* const input = { /* empty *\/ };
|
|
91
|
+
* const command = new ListSessionLoggersCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* sessionLoggers: [
|
|
96
|
+
* {
|
|
97
|
+
* creationDate: "2024-01-15T10:30:00Z",
|
|
98
|
+
* displayName: "Session Logger with All Events",
|
|
99
|
+
* logConfiguration: {
|
|
100
|
+
* s3: {
|
|
101
|
+
* bucket: "my-session-logs-bucket-1",
|
|
102
|
+
* bucketOwner: "123456789012",
|
|
103
|
+
* folderStructure: "Flat",
|
|
104
|
+
* keyPrefix: "session-logs/all/events",
|
|
105
|
+
* logFileFormat: "Json"
|
|
106
|
+
* }
|
|
107
|
+
* },
|
|
108
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
|
|
109
|
+
* },
|
|
110
|
+
* {
|
|
111
|
+
* creationDate: "2024-01-15T14:45:00Z",
|
|
112
|
+
* displayName: "Session Logger with Each Events",
|
|
113
|
+
* logConfiguration: {
|
|
114
|
+
* s3: {
|
|
115
|
+
* bucket: "my-session-logs-bucket-2",
|
|
116
|
+
* bucketOwner: "123456789012",
|
|
117
|
+
* folderStructure: "NestedByDate",
|
|
118
|
+
* keyPrefix: "session-logs/each/event",
|
|
119
|
+
* logFileFormat: "JSONLines"
|
|
120
|
+
* }
|
|
121
|
+
* },
|
|
122
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
|
|
123
|
+
* }
|
|
124
|
+
* ]
|
|
125
|
+
* }
|
|
126
|
+
* *\/
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
129
|
+
* @example List Session Loggers with Pagination
|
|
130
|
+
* ```javascript
|
|
131
|
+
* // Lists session loggers with pagination parameters
|
|
132
|
+
* const input = {
|
|
133
|
+
* maxResults: 1,
|
|
134
|
+
* nextToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
|
|
135
|
+
* };
|
|
136
|
+
* const command = new ListSessionLoggersCommand(input);
|
|
137
|
+
* const response = await client.send(command);
|
|
138
|
+
* /* response is
|
|
139
|
+
* {
|
|
140
|
+
* nextToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
|
|
141
|
+
* sessionLoggers: [
|
|
142
|
+
* {
|
|
143
|
+
* creationDate: "2024-03-15T12:45:00Z",
|
|
144
|
+
* displayName: "Session Logger Example with Pagination",
|
|
145
|
+
* logConfiguration: {
|
|
146
|
+
* s3: {
|
|
147
|
+
* bucket: "my-session-logs-bucket-3",
|
|
148
|
+
* bucketOwner: "123456789012",
|
|
149
|
+
* folderStructure: "Flat",
|
|
150
|
+
* keyPrefix: "session-logs/pagination/example",
|
|
151
|
+
* logFileFormat: "JSONLines"
|
|
152
|
+
* }
|
|
153
|
+
* },
|
|
154
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111"
|
|
155
|
+
* }
|
|
156
|
+
* ]
|
|
157
|
+
* }
|
|
158
|
+
* *\/
|
|
159
|
+
* ```
|
|
160
|
+
*
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
export declare class ListSessionLoggersCommand extends ListSessionLoggersCommand_base {
|
|
164
|
+
/** @internal type navigation helper, not in runtime. */
|
|
165
|
+
protected static __types: {
|
|
166
|
+
api: {
|
|
167
|
+
input: ListSessionLoggersRequest;
|
|
168
|
+
output: ListSessionLoggersResponse;
|
|
169
|
+
};
|
|
170
|
+
sdk: {
|
|
171
|
+
input: ListSessionLoggersCommandInput;
|
|
172
|
+
output: ListSessionLoggersCommandOutput;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
}
|
|
@@ -56,6 +56,7 @@ declare const UpdatePortalCommand_base: {
|
|
|
56
56
|
* // dataProtectionSettingsArn: "STRING_VALUE",
|
|
57
57
|
* // userSettingsArn: "STRING_VALUE",
|
|
58
58
|
* // networkSettingsArn: "STRING_VALUE",
|
|
59
|
+
* // sessionLoggerArn: "STRING_VALUE",
|
|
59
60
|
* // trustStoreArn: "STRING_VALUE",
|
|
60
61
|
* // statusReason: "STRING_VALUE",
|
|
61
62
|
* // userAccessLoggingSettingsArn: "STRING_VALUE",
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateSessionLoggerRequest, UpdateSessionLoggerResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesWebClientResolvedConfig } from "../WorkSpacesWebClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateSessionLoggerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateSessionLoggerCommandInput extends UpdateSessionLoggerRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateSessionLoggerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateSessionLoggerCommandOutput extends UpdateSessionLoggerResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateSessionLoggerCommand_base: {
|
|
25
|
+
new (input: UpdateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionLoggerCommandInput, UpdateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateSessionLoggerCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionLoggerCommandInput, UpdateSessionLoggerCommandOutput, WorkSpacesWebClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the details of a session logger.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WorkSpacesWebClient, UpdateSessionLoggerCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
|
|
35
|
+
* // const { WorkSpacesWebClient, UpdateSessionLoggerCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
|
|
36
|
+
* const client = new WorkSpacesWebClient(config);
|
|
37
|
+
* const input = { // UpdateSessionLoggerRequest
|
|
38
|
+
* sessionLoggerArn: "STRING_VALUE", // required
|
|
39
|
+
* eventFilter: { // EventFilter Union: only one key present
|
|
40
|
+
* all: {},
|
|
41
|
+
* include: [ // Events
|
|
42
|
+
* "WebsiteInteract" || "FileDownloadFromSecureBrowserToRemoteDisk" || "FileTransferFromRemoteToLocalDisk" || "FileTransferFromLocalToRemoteDisk" || "FileUploadFromRemoteDiskToSecureBrowser" || "ContentPasteToWebsite" || "ContentTransferFromLocalToRemoteClipboard" || "ContentCopyFromWebsite" || "UrlLoad" || "TabOpen" || "TabClose" || "PrintJobSubmit" || "SessionConnect" || "SessionStart" || "SessionDisconnect" || "SessionEnd",
|
|
43
|
+
* ],
|
|
44
|
+
* },
|
|
45
|
+
* logConfiguration: { // LogConfiguration
|
|
46
|
+
* s3: { // S3LogConfiguration
|
|
47
|
+
* bucket: "STRING_VALUE", // required
|
|
48
|
+
* keyPrefix: "STRING_VALUE",
|
|
49
|
+
* bucketOwner: "STRING_VALUE",
|
|
50
|
+
* logFileFormat: "JSONLines" || "Json", // required
|
|
51
|
+
* folderStructure: "Flat" || "NestedByDate", // required
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* displayName: "STRING_VALUE",
|
|
55
|
+
* };
|
|
56
|
+
* const command = new UpdateSessionLoggerCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* // { // UpdateSessionLoggerResponse
|
|
59
|
+
* // sessionLogger: { // SessionLogger
|
|
60
|
+
* // sessionLoggerArn: "STRING_VALUE", // required
|
|
61
|
+
* // eventFilter: { // EventFilter Union: only one key present
|
|
62
|
+
* // all: {},
|
|
63
|
+
* // include: [ // Events
|
|
64
|
+
* // "WebsiteInteract" || "FileDownloadFromSecureBrowserToRemoteDisk" || "FileTransferFromRemoteToLocalDisk" || "FileTransferFromLocalToRemoteDisk" || "FileUploadFromRemoteDiskToSecureBrowser" || "ContentPasteToWebsite" || "ContentTransferFromLocalToRemoteClipboard" || "ContentCopyFromWebsite" || "UrlLoad" || "TabOpen" || "TabClose" || "PrintJobSubmit" || "SessionConnect" || "SessionStart" || "SessionDisconnect" || "SessionEnd",
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // logConfiguration: { // LogConfiguration
|
|
68
|
+
* // s3: { // S3LogConfiguration
|
|
69
|
+
* // bucket: "STRING_VALUE", // required
|
|
70
|
+
* // keyPrefix: "STRING_VALUE",
|
|
71
|
+
* // bucketOwner: "STRING_VALUE",
|
|
72
|
+
* // logFileFormat: "JSONLines" || "Json", // required
|
|
73
|
+
* // folderStructure: "Flat" || "NestedByDate", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // customerManagedKey: "STRING_VALUE",
|
|
77
|
+
* // additionalEncryptionContext: { // EncryptionContextMap
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // associatedPortalArns: [ // ArnList
|
|
81
|
+
* // "STRING_VALUE",
|
|
82
|
+
* // ],
|
|
83
|
+
* // displayName: "STRING_VALUE",
|
|
84
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
85
|
+
* // },
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @param UpdateSessionLoggerCommandInput - {@link UpdateSessionLoggerCommandInput}
|
|
91
|
+
* @returns {@link UpdateSessionLoggerCommandOutput}
|
|
92
|
+
* @see {@link UpdateSessionLoggerCommandInput} for command's `input` shape.
|
|
93
|
+
* @see {@link UpdateSessionLoggerCommandOutput} for command's `response` shape.
|
|
94
|
+
* @see {@link WorkSpacesWebClientResolvedConfig | config} for WorkSpacesWebClient's `config` shape.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
97
|
+
* <p>Access is denied.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link InternalServerException} (server fault)
|
|
100
|
+
* <p>There is an internal server error.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
103
|
+
* <p>The resource cannot be found.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
+
* <p>There is a throttling error.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ValidationException} (client fault)
|
|
109
|
+
* <p>There is a validation error.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link WorkSpacesWebServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from WorkSpacesWeb service.</p>
|
|
113
|
+
*
|
|
114
|
+
*
|
|
115
|
+
* @example Update Session Logger Event Filter
|
|
116
|
+
* ```javascript
|
|
117
|
+
* // Updates a session logger to capture specific events instead of all events
|
|
118
|
+
* const input = {
|
|
119
|
+
* eventFilter: {
|
|
120
|
+
* include: [
|
|
121
|
+
* "SessionStart",
|
|
122
|
+
* "SessionEnd",
|
|
123
|
+
* "UrlLoad",
|
|
124
|
+
* "WebsiteInteract"
|
|
125
|
+
* ]
|
|
126
|
+
* },
|
|
127
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
|
|
128
|
+
* };
|
|
129
|
+
* const command = new UpdateSessionLoggerCommand(input);
|
|
130
|
+
* const response = await client.send(command);
|
|
131
|
+
* /* response is
|
|
132
|
+
* {
|
|
133
|
+
* sessionLogger: {
|
|
134
|
+
* creationDate: "2024-01-15T10:30:00Z",
|
|
135
|
+
* displayName: "Updated Session Logger with Specific Events",
|
|
136
|
+
* eventFilter: {
|
|
137
|
+
* include: [
|
|
138
|
+
* "SessionStart",
|
|
139
|
+
* "SessionEnd",
|
|
140
|
+
* "UrlLoad",
|
|
141
|
+
* "WebsiteInteract"
|
|
142
|
+
* ]
|
|
143
|
+
* },
|
|
144
|
+
* logConfiguration: {
|
|
145
|
+
* s3: {
|
|
146
|
+
* bucket: "my-session-logs-bucket",
|
|
147
|
+
* bucketOwner: "123456789012",
|
|
148
|
+
* folderStructure: "Flat",
|
|
149
|
+
* keyPrefix: "updated/session-logs/each/event",
|
|
150
|
+
* logFileFormat: "Json"
|
|
151
|
+
* }
|
|
152
|
+
* },
|
|
153
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012"
|
|
154
|
+
* }
|
|
155
|
+
* }
|
|
156
|
+
* *\/
|
|
157
|
+
* ```
|
|
158
|
+
*
|
|
159
|
+
* @example Update Session Logger Configuration
|
|
160
|
+
* ```javascript
|
|
161
|
+
* // Updates the log configuration of a session logger
|
|
162
|
+
* const input = {
|
|
163
|
+
* logConfiguration: {
|
|
164
|
+
* s3: {
|
|
165
|
+
* bucket: "updated-my-session-logs-bucket-2",
|
|
166
|
+
* bucketOwner: "123456789012",
|
|
167
|
+
* folderStructure: "Flat",
|
|
168
|
+
* keyPrefix: "updated/key/prefix",
|
|
169
|
+
* logFileFormat: "Json"
|
|
170
|
+
* }
|
|
171
|
+
* },
|
|
172
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
|
|
173
|
+
* };
|
|
174
|
+
* const command = new UpdateSessionLoggerCommand(input);
|
|
175
|
+
* const response = await client.send(command);
|
|
176
|
+
* /* response is
|
|
177
|
+
* {
|
|
178
|
+
* sessionLogger: {
|
|
179
|
+
* additionalEncryptionContext: {
|
|
180
|
+
* EncryptionContextKey: "EncryptionContextValue"
|
|
181
|
+
* },
|
|
182
|
+
* creationDate: "2024-01-15T14:45:00Z",
|
|
183
|
+
* customerManagedKey: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012",
|
|
184
|
+
* displayName: "Updated Session Logger with Log Config",
|
|
185
|
+
* eventFilter: {
|
|
186
|
+
* all: { /* empty *\/ }
|
|
187
|
+
* },
|
|
188
|
+
* logConfiguration: {
|
|
189
|
+
* s3: {
|
|
190
|
+
* bucket: "updated-my-session-logs-bucket-2",
|
|
191
|
+
* bucketOwner: "123456789012",
|
|
192
|
+
* folderStructure: "Flat",
|
|
193
|
+
* keyPrefix: "updated/key/prefix",
|
|
194
|
+
* logFileFormat: "Json"
|
|
195
|
+
* }
|
|
196
|
+
* },
|
|
197
|
+
* sessionLoggerArn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321"
|
|
198
|
+
* }
|
|
199
|
+
* }
|
|
200
|
+
* *\/
|
|
201
|
+
* ```
|
|
202
|
+
*
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
export declare class UpdateSessionLoggerCommand extends UpdateSessionLoggerCommand_base {
|
|
206
|
+
/** @internal type navigation helper, not in runtime. */
|
|
207
|
+
protected static __types: {
|
|
208
|
+
api: {
|
|
209
|
+
input: UpdateSessionLoggerRequest;
|
|
210
|
+
output: UpdateSessionLoggerResponse;
|
|
211
|
+
};
|
|
212
|
+
sdk: {
|
|
213
|
+
input: UpdateSessionLoggerCommandInput;
|
|
214
|
+
output: UpdateSessionLoggerCommandOutput;
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
}
|
|
@@ -2,6 +2,7 @@ export * from "./AssociateBrowserSettingsCommand";
|
|
|
2
2
|
export * from "./AssociateDataProtectionSettingsCommand";
|
|
3
3
|
export * from "./AssociateIpAccessSettingsCommand";
|
|
4
4
|
export * from "./AssociateNetworkSettingsCommand";
|
|
5
|
+
export * from "./AssociateSessionLoggerCommand";
|
|
5
6
|
export * from "./AssociateTrustStoreCommand";
|
|
6
7
|
export * from "./AssociateUserAccessLoggingSettingsCommand";
|
|
7
8
|
export * from "./AssociateUserSettingsCommand";
|
|
@@ -11,6 +12,7 @@ export * from "./CreateIdentityProviderCommand";
|
|
|
11
12
|
export * from "./CreateIpAccessSettingsCommand";
|
|
12
13
|
export * from "./CreateNetworkSettingsCommand";
|
|
13
14
|
export * from "./CreatePortalCommand";
|
|
15
|
+
export * from "./CreateSessionLoggerCommand";
|
|
14
16
|
export * from "./CreateTrustStoreCommand";
|
|
15
17
|
export * from "./CreateUserAccessLoggingSettingsCommand";
|
|
16
18
|
export * from "./CreateUserSettingsCommand";
|
|
@@ -20,6 +22,7 @@ export * from "./DeleteIdentityProviderCommand";
|
|
|
20
22
|
export * from "./DeleteIpAccessSettingsCommand";
|
|
21
23
|
export * from "./DeleteNetworkSettingsCommand";
|
|
22
24
|
export * from "./DeletePortalCommand";
|
|
25
|
+
export * from "./DeleteSessionLoggerCommand";
|
|
23
26
|
export * from "./DeleteTrustStoreCommand";
|
|
24
27
|
export * from "./DeleteUserAccessLoggingSettingsCommand";
|
|
25
28
|
export * from "./DeleteUserSettingsCommand";
|
|
@@ -27,6 +30,7 @@ export * from "./DisassociateBrowserSettingsCommand";
|
|
|
27
30
|
export * from "./DisassociateDataProtectionSettingsCommand";
|
|
28
31
|
export * from "./DisassociateIpAccessSettingsCommand";
|
|
29
32
|
export * from "./DisassociateNetworkSettingsCommand";
|
|
33
|
+
export * from "./DisassociateSessionLoggerCommand";
|
|
30
34
|
export * from "./DisassociateTrustStoreCommand";
|
|
31
35
|
export * from "./DisassociateUserAccessLoggingSettingsCommand";
|
|
32
36
|
export * from "./DisassociateUserSettingsCommand";
|
|
@@ -39,6 +43,7 @@ export * from "./GetNetworkSettingsCommand";
|
|
|
39
43
|
export * from "./GetPortalCommand";
|
|
40
44
|
export * from "./GetPortalServiceProviderMetadataCommand";
|
|
41
45
|
export * from "./GetSessionCommand";
|
|
46
|
+
export * from "./GetSessionLoggerCommand";
|
|
42
47
|
export * from "./GetTrustStoreCertificateCommand";
|
|
43
48
|
export * from "./GetTrustStoreCommand";
|
|
44
49
|
export * from "./GetUserAccessLoggingSettingsCommand";
|
|
@@ -49,6 +54,7 @@ export * from "./ListIdentityProvidersCommand";
|
|
|
49
54
|
export * from "./ListIpAccessSettingsCommand";
|
|
50
55
|
export * from "./ListNetworkSettingsCommand";
|
|
51
56
|
export * from "./ListPortalsCommand";
|
|
57
|
+
export * from "./ListSessionLoggersCommand";
|
|
52
58
|
export * from "./ListSessionsCommand";
|
|
53
59
|
export * from "./ListTagsForResourceCommand";
|
|
54
60
|
export * from "./ListTrustStoreCertificatesCommand";
|
|
@@ -63,6 +69,7 @@ export * from "./UpdateIdentityProviderCommand";
|
|
|
63
69
|
export * from "./UpdateIpAccessSettingsCommand";
|
|
64
70
|
export * from "./UpdateNetworkSettingsCommand";
|
|
65
71
|
export * from "./UpdatePortalCommand";
|
|
72
|
+
export * from "./UpdateSessionLoggerCommand";
|
|
66
73
|
export * from "./UpdateTrustStoreCommand";
|
|
67
74
|
export * from "./UpdateUserAccessLoggingSettingsCommand";
|
|
68
75
|
export * from "./UpdateUserSettingsCommand";
|