@aws-sdk/client-wickr 3.956.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/LICENSE +201 -0
- package/README.md +541 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +2520 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +55 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-es/Wickr.js +91 -0
- package/dist-es/WickrClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/BatchCreateUserCommand.js +16 -0
- package/dist-es/commands/BatchDeleteUserCommand.js +16 -0
- package/dist-es/commands/BatchLookupUserUnameCommand.js +16 -0
- package/dist-es/commands/BatchReinviteUserCommand.js +16 -0
- package/dist-es/commands/BatchResetDevicesForUserCommand.js +16 -0
- package/dist-es/commands/BatchToggleUserSuspendStatusCommand.js +16 -0
- package/dist-es/commands/CreateBotCommand.js +16 -0
- package/dist-es/commands/CreateDataRetentionBotChallengeCommand.js +16 -0
- package/dist-es/commands/CreateDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/CreateNetworkCommand.js +16 -0
- package/dist-es/commands/CreateSecurityGroupCommand.js +16 -0
- package/dist-es/commands/DeleteBotCommand.js +16 -0
- package/dist-es/commands/DeleteDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/DeleteNetworkCommand.js +16 -0
- package/dist-es/commands/DeleteSecurityGroupCommand.js +16 -0
- package/dist-es/commands/GetBotCommand.js +16 -0
- package/dist-es/commands/GetBotsCountCommand.js +16 -0
- package/dist-es/commands/GetDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/GetGuestUserHistoryCountCommand.js +16 -0
- package/dist-es/commands/GetNetworkCommand.js +16 -0
- package/dist-es/commands/GetNetworkSettingsCommand.js +16 -0
- package/dist-es/commands/GetOidcInfoCommand.js +16 -0
- package/dist-es/commands/GetSecurityGroupCommand.js +16 -0
- package/dist-es/commands/GetUserCommand.js +16 -0
- package/dist-es/commands/GetUsersCountCommand.js +16 -0
- package/dist-es/commands/ListBlockedGuestUsersCommand.js +16 -0
- package/dist-es/commands/ListBotsCommand.js +16 -0
- package/dist-es/commands/ListDevicesForUserCommand.js +16 -0
- package/dist-es/commands/ListGuestUsersCommand.js +16 -0
- package/dist-es/commands/ListNetworksCommand.js +16 -0
- package/dist-es/commands/ListSecurityGroupUsersCommand.js +16 -0
- package/dist-es/commands/ListSecurityGroupsCommand.js +16 -0
- package/dist-es/commands/ListUsersCommand.js +16 -0
- package/dist-es/commands/RegisterOidcConfigCommand.js +16 -0
- package/dist-es/commands/RegisterOidcConfigTestCommand.js +16 -0
- package/dist-es/commands/UpdateBotCommand.js +16 -0
- package/dist-es/commands/UpdateDataRetentionCommand.js +16 -0
- package/dist-es/commands/UpdateGuestUserCommand.js +16 -0
- package/dist-es/commands/UpdateNetworkCommand.js +16 -0
- package/dist-es/commands/UpdateNetworkSettingsCommand.js +16 -0
- package/dist-es/commands/UpdateSecurityGroupCommand.js +16 -0
- package/dist-es/commands/UpdateUserCommand.js +16 -0
- package/dist-es/commands/index.js +42 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +9 -0
- package/dist-es/models/WickrServiceException.js +8 -0
- package/dist-es/models/enums.js +28 -0
- package/dist-es/models/errors.js +87 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListBlockedGuestUsersPaginator.js +4 -0
- package/dist-es/pagination/ListBotsPaginator.js +4 -0
- package/dist-es/pagination/ListDevicesForUserPaginator.js +4 -0
- package/dist-es/pagination/ListGuestUsersPaginator.js +4 -0
- package/dist-es/pagination/ListNetworksPaginator.js +4 -0
- package/dist-es/pagination/ListSecurityGroupUsersPaginator.js +4 -0
- package/dist-es/pagination/ListSecurityGroupsPaginator.js +4 -0
- package/dist-es/pagination/ListUsersPaginator.js +4 -0
- package/dist-es/pagination/index.js +9 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +50 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +1491 -0
- package/dist-types/Wickr.d.ts +305 -0
- package/dist-types/WickrClient.d.ts +229 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/BatchCreateUserCommand.d.ts +251 -0
- package/dist-types/commands/BatchDeleteUserCommand.d.ts +171 -0
- package/dist-types/commands/BatchLookupUserUnameCommand.d.ts +175 -0
- package/dist-types/commands/BatchReinviteUserCommand.d.ts +191 -0
- package/dist-types/commands/BatchResetDevicesForUserCommand.d.ts +190 -0
- package/dist-types/commands/BatchToggleUserSuspendStatusCommand.d.ts +174 -0
- package/dist-types/commands/CreateBotCommand.d.ts +161 -0
- package/dist-types/commands/CreateDataRetentionBotChallengeCommand.d.ts +110 -0
- package/dist-types/commands/CreateDataRetentionBotCommand.d.ts +123 -0
- package/dist-types/commands/CreateNetworkCommand.d.ts +150 -0
- package/dist-types/commands/CreateSecurityGroupCommand.d.ts +241 -0
- package/dist-types/commands/DeleteBotCommand.d.ts +126 -0
- package/dist-types/commands/DeleteDataRetentionBotCommand.d.ts +110 -0
- package/dist-types/commands/DeleteNetworkCommand.d.ts +124 -0
- package/dist-types/commands/DeleteSecurityGroupCommand.d.ts +130 -0
- package/dist-types/commands/GetBotCommand.d.ts +144 -0
- package/dist-types/commands/GetBotsCountCommand.d.ts +131 -0
- package/dist-types/commands/GetDataRetentionBotCommand.d.ts +140 -0
- package/dist-types/commands/GetGuestUserHistoryCountCommand.d.ts +155 -0
- package/dist-types/commands/GetNetworkCommand.d.ts +137 -0
- package/dist-types/commands/GetNetworkSettingsCommand.d.ts +166 -0
- package/dist-types/commands/GetOidcInfoCommand.d.ts +169 -0
- package/dist-types/commands/GetSecurityGroupCommand.d.ts +211 -0
- package/dist-types/commands/GetUserCommand.d.ts +194 -0
- package/dist-types/commands/GetUsersCountCommand.d.ts +137 -0
- package/dist-types/commands/ListBlockedGuestUsersCommand.d.ts +185 -0
- package/dist-types/commands/ListBotsCommand.d.ts +192 -0
- package/dist-types/commands/ListDevicesForUserCommand.d.ts +197 -0
- package/dist-types/commands/ListGuestUsersCommand.d.ts +192 -0
- package/dist-types/commands/ListNetworksCommand.d.ts +167 -0
- package/dist-types/commands/ListSecurityGroupUsersCommand.d.ts +156 -0
- package/dist-types/commands/ListSecurityGroupsCommand.d.ts +246 -0
- package/dist-types/commands/ListUsersCommand.d.ts +221 -0
- package/dist-types/commands/RegisterOidcConfigCommand.d.ts +174 -0
- package/dist-types/commands/RegisterOidcConfigTestCommand.d.ts +168 -0
- package/dist-types/commands/UpdateBotCommand.d.ts +133 -0
- package/dist-types/commands/UpdateDataRetentionCommand.d.ts +144 -0
- package/dist-types/commands/UpdateGuestUserCommand.d.ts +146 -0
- package/dist-types/commands/UpdateNetworkCommand.d.ts +142 -0
- package/dist-types/commands/UpdateNetworkSettingsCommand.d.ts +234 -0
- package/dist-types/commands/UpdateSecurityGroupCommand.d.ts +282 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +229 -0
- package/dist-types/commands/index.d.ts +42 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +17 -0
- package/dist-types/models/WickrServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +58 -0
- package/dist-types/models/errors.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +2975 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListBlockedGuestUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBotsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDevicesForUserPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGuestUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNetworksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSecurityGroupUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSecurityGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +164 -0
- package/dist-types/ts3.4/Wickr.d.ts +720 -0
- package/dist-types/ts3.4/WickrClient.d.ts +371 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchCreateUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchDeleteUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchLookupUserUnameCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchReinviteUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchResetDevicesForUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchToggleUserSuspendStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateDataRetentionBotChallengeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBotCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetBotsCountCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetGuestUserHistoryCountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetNetworkCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetNetworkSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetOidcInfoCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetSecurityGroupCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +43 -0
- package/dist-types/ts3.4/commands/GetUsersCountCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListBlockedGuestUsersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDevicesForUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListGuestUsersCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListNetworksCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListSecurityGroupUsersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListSecurityGroupsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/RegisterOidcConfigCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RegisterOidcConfigTestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateDataRetentionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateGuestUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateNetworkSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +42 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +12 -0
- package/dist-types/ts3.4/models/WickrServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +31 -0
- package/dist-types/ts3.4/models/errors.d.ts +43 -0
- package/dist-types/ts3.4/models/models_0.d.ts +714 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListBlockedGuestUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBotsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDevicesForUserPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGuestUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNetworksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSecurityGroupUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSecurityGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +168 -0
- package/package.json +100 -0
package/README.md
ADDED
|
@@ -0,0 +1,541 @@
|
|
|
1
|
+
<!-- generated file, do not edit directly -->
|
|
2
|
+
|
|
3
|
+
# @aws-sdk/client-wickr
|
|
4
|
+
|
|
5
|
+
## Description
|
|
6
|
+
|
|
7
|
+
AWS SDK for JavaScript Wickr Client for Node.js, Browser and React Native.
|
|
8
|
+
|
|
9
|
+
<p>Welcome to the <i>Amazon Web Services Wickr API Reference</i>.</p> <p>The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr. </p> <p> <i>Using Amazon Web Services SDK</i> </p> <p>The SDK clients authenticate your requests by using access keys that you provide. For more information, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/access.html">Authentication and access using Amazon Web Services SDKs and tools</a> in the <i>Amazon Web Services SDKs and Tools Reference Guide</i>. </p> <p> <i>Using Amazon Web Services CLI</i> </p> <p>Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html">Getting started with the Amazon Web Services CLI</a> in the <i>Amazon Web Services Command Line Interface User Guide for Version 2</i>. </p> <p> <i>Using REST APIs</i> </p> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>. </p> <p>Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AWSWickrFullAccess">Amazon Web ServicesWickrFullAccess</a> grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam.html">Identity and access management for Amazon Web Services Wickr </a> in the <i>Amazon Web Services Wickr Administration Guide</i>. </p> <p> <i>Types of Errors</i>:</p> <p>The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.</p> <ol> <li> <p>Client errors are indicated by HTTP Status Code class of 4xx</p> </li> <li> <p>Service errors are indicated by HTTP Status Code class of 5xx</p> </li> </ol> <p>In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.</p>
|
|
10
|
+
|
|
11
|
+
## Installing
|
|
12
|
+
|
|
13
|
+
To install this package, simply type add or install @aws-sdk/client-wickr
|
|
14
|
+
using your favorite package manager:
|
|
15
|
+
|
|
16
|
+
- `npm install @aws-sdk/client-wickr`
|
|
17
|
+
- `yarn add @aws-sdk/client-wickr`
|
|
18
|
+
- `pnpm add @aws-sdk/client-wickr`
|
|
19
|
+
|
|
20
|
+
## Getting Started
|
|
21
|
+
|
|
22
|
+
### Import
|
|
23
|
+
|
|
24
|
+
The AWS SDK is modulized by clients and commands.
|
|
25
|
+
To send a request, you only need to import the `WickrClient` and
|
|
26
|
+
the commands you need, for example `ListBotsCommand`:
|
|
27
|
+
|
|
28
|
+
```js
|
|
29
|
+
// ES5 example
|
|
30
|
+
const { WickrClient, ListBotsCommand } = require("@aws-sdk/client-wickr");
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
// ES6+ example
|
|
35
|
+
import { WickrClient, ListBotsCommand } from "@aws-sdk/client-wickr";
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Usage
|
|
39
|
+
|
|
40
|
+
To send a request, you:
|
|
41
|
+
|
|
42
|
+
- Initiate client with configuration (e.g. credentials, region).
|
|
43
|
+
- Initiate command with input parameters.
|
|
44
|
+
- Call `send` operation on client with command object as input.
|
|
45
|
+
- If you are using a custom http handler, you may call `destroy()` to close open connections.
|
|
46
|
+
|
|
47
|
+
```js
|
|
48
|
+
// a client can be shared by different commands.
|
|
49
|
+
const client = new WickrClient({ region: "REGION" });
|
|
50
|
+
|
|
51
|
+
const params = {
|
|
52
|
+
/** input parameters */
|
|
53
|
+
};
|
|
54
|
+
const command = new ListBotsCommand(params);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Async/await
|
|
58
|
+
|
|
59
|
+
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
60
|
+
operator to wait for the promise returned by send operation as follows:
|
|
61
|
+
|
|
62
|
+
```js
|
|
63
|
+
// async/await.
|
|
64
|
+
try {
|
|
65
|
+
const data = await client.send(command);
|
|
66
|
+
// process data.
|
|
67
|
+
} catch (error) {
|
|
68
|
+
// error handling.
|
|
69
|
+
} finally {
|
|
70
|
+
// finally.
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
75
|
+
as compared to using Promise chains or callbacks.
|
|
76
|
+
|
|
77
|
+
#### Promises
|
|
78
|
+
|
|
79
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
80
|
+
to execute send operation.
|
|
81
|
+
|
|
82
|
+
```js
|
|
83
|
+
client.send(command).then(
|
|
84
|
+
(data) => {
|
|
85
|
+
// process data.
|
|
86
|
+
},
|
|
87
|
+
(error) => {
|
|
88
|
+
// error handling.
|
|
89
|
+
}
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
94
|
+
|
|
95
|
+
```js
|
|
96
|
+
client
|
|
97
|
+
.send(command)
|
|
98
|
+
.then((data) => {
|
|
99
|
+
// process data.
|
|
100
|
+
})
|
|
101
|
+
.catch((error) => {
|
|
102
|
+
// error handling.
|
|
103
|
+
})
|
|
104
|
+
.finally(() => {
|
|
105
|
+
// finally.
|
|
106
|
+
});
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
#### Callbacks
|
|
110
|
+
|
|
111
|
+
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
112
|
+
but they are supported by the send operation.
|
|
113
|
+
|
|
114
|
+
```js
|
|
115
|
+
// callbacks.
|
|
116
|
+
client.send(command, (err, data) => {
|
|
117
|
+
// process err and data.
|
|
118
|
+
});
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### v2 compatible style
|
|
122
|
+
|
|
123
|
+
The client can also send requests using v2 compatible style.
|
|
124
|
+
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
|
|
125
|
+
on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
|
|
126
|
+
|
|
127
|
+
```ts
|
|
128
|
+
import * as AWS from "@aws-sdk/client-wickr";
|
|
129
|
+
const client = new AWS.Wickr({ region: "REGION" });
|
|
130
|
+
|
|
131
|
+
// async/await.
|
|
132
|
+
try {
|
|
133
|
+
const data = await client.listBots(params);
|
|
134
|
+
// process data.
|
|
135
|
+
} catch (error) {
|
|
136
|
+
// error handling.
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// Promises.
|
|
140
|
+
client
|
|
141
|
+
.listBots(params)
|
|
142
|
+
.then((data) => {
|
|
143
|
+
// process data.
|
|
144
|
+
})
|
|
145
|
+
.catch((error) => {
|
|
146
|
+
// error handling.
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
// callbacks.
|
|
150
|
+
client.listBots(params, (err, data) => {
|
|
151
|
+
// process err and data.
|
|
152
|
+
});
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Troubleshooting
|
|
156
|
+
|
|
157
|
+
When the service returns an exception, the error will include the exception information,
|
|
158
|
+
as well as response metadata (e.g. request id).
|
|
159
|
+
|
|
160
|
+
```js
|
|
161
|
+
try {
|
|
162
|
+
const data = await client.send(command);
|
|
163
|
+
// process data.
|
|
164
|
+
} catch (error) {
|
|
165
|
+
const { requestId, cfId, extendedRequestId } = error.$metadata;
|
|
166
|
+
console.log({ requestId, cfId, extendedRequestId });
|
|
167
|
+
/**
|
|
168
|
+
* The keys within exceptions are also parsed.
|
|
169
|
+
* You can access them by specifying exception names:
|
|
170
|
+
* if (error.name === 'SomeServiceException') {
|
|
171
|
+
* const value = error.specialKeyInException;
|
|
172
|
+
* }
|
|
173
|
+
*/
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Getting Help
|
|
178
|
+
|
|
179
|
+
Please use these community resources for getting help.
|
|
180
|
+
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
181
|
+
|
|
182
|
+
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
183
|
+
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
184
|
+
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
185
|
+
on AWS Developer Blog.
|
|
186
|
+
- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.
|
|
187
|
+
- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).
|
|
188
|
+
- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).
|
|
189
|
+
|
|
190
|
+
To test your universal JavaScript code in Node.js, browser and react-native environments,
|
|
191
|
+
visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
|
|
192
|
+
|
|
193
|
+
## Contributing
|
|
194
|
+
|
|
195
|
+
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-wickr` package is updated.
|
|
196
|
+
To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).
|
|
197
|
+
|
|
198
|
+
## License
|
|
199
|
+
|
|
200
|
+
This SDK is distributed under the
|
|
201
|
+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
|
|
202
|
+
see LICENSE for more information.
|
|
203
|
+
|
|
204
|
+
## Client Commands (Operations List)
|
|
205
|
+
|
|
206
|
+
<details>
|
|
207
|
+
<summary>
|
|
208
|
+
BatchCreateUser
|
|
209
|
+
</summary>
|
|
210
|
+
|
|
211
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchCreateUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchCreateUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchCreateUserCommandOutput/)
|
|
212
|
+
|
|
213
|
+
</details>
|
|
214
|
+
<details>
|
|
215
|
+
<summary>
|
|
216
|
+
BatchDeleteUser
|
|
217
|
+
</summary>
|
|
218
|
+
|
|
219
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchDeleteUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchDeleteUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchDeleteUserCommandOutput/)
|
|
220
|
+
|
|
221
|
+
</details>
|
|
222
|
+
<details>
|
|
223
|
+
<summary>
|
|
224
|
+
BatchLookupUserUname
|
|
225
|
+
</summary>
|
|
226
|
+
|
|
227
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchLookupUserUnameCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchLookupUserUnameCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchLookupUserUnameCommandOutput/)
|
|
228
|
+
|
|
229
|
+
</details>
|
|
230
|
+
<details>
|
|
231
|
+
<summary>
|
|
232
|
+
BatchReinviteUser
|
|
233
|
+
</summary>
|
|
234
|
+
|
|
235
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchReinviteUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchReinviteUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchReinviteUserCommandOutput/)
|
|
236
|
+
|
|
237
|
+
</details>
|
|
238
|
+
<details>
|
|
239
|
+
<summary>
|
|
240
|
+
BatchResetDevicesForUser
|
|
241
|
+
</summary>
|
|
242
|
+
|
|
243
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchResetDevicesForUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchResetDevicesForUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchResetDevicesForUserCommandOutput/)
|
|
244
|
+
|
|
245
|
+
</details>
|
|
246
|
+
<details>
|
|
247
|
+
<summary>
|
|
248
|
+
BatchToggleUserSuspendStatus
|
|
249
|
+
</summary>
|
|
250
|
+
|
|
251
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/BatchToggleUserSuspendStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchToggleUserSuspendStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/BatchToggleUserSuspendStatusCommandOutput/)
|
|
252
|
+
|
|
253
|
+
</details>
|
|
254
|
+
<details>
|
|
255
|
+
<summary>
|
|
256
|
+
CreateBot
|
|
257
|
+
</summary>
|
|
258
|
+
|
|
259
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/CreateBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateBotCommandOutput/)
|
|
260
|
+
|
|
261
|
+
</details>
|
|
262
|
+
<details>
|
|
263
|
+
<summary>
|
|
264
|
+
CreateDataRetentionBot
|
|
265
|
+
</summary>
|
|
266
|
+
|
|
267
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/CreateDataRetentionBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateDataRetentionBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateDataRetentionBotCommandOutput/)
|
|
268
|
+
|
|
269
|
+
</details>
|
|
270
|
+
<details>
|
|
271
|
+
<summary>
|
|
272
|
+
CreateDataRetentionBotChallenge
|
|
273
|
+
</summary>
|
|
274
|
+
|
|
275
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/CreateDataRetentionBotChallengeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateDataRetentionBotChallengeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateDataRetentionBotChallengeCommandOutput/)
|
|
276
|
+
|
|
277
|
+
</details>
|
|
278
|
+
<details>
|
|
279
|
+
<summary>
|
|
280
|
+
CreateNetwork
|
|
281
|
+
</summary>
|
|
282
|
+
|
|
283
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/CreateNetworkCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateNetworkCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateNetworkCommandOutput/)
|
|
284
|
+
|
|
285
|
+
</details>
|
|
286
|
+
<details>
|
|
287
|
+
<summary>
|
|
288
|
+
CreateSecurityGroup
|
|
289
|
+
</summary>
|
|
290
|
+
|
|
291
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/CreateSecurityGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateSecurityGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/CreateSecurityGroupCommandOutput/)
|
|
292
|
+
|
|
293
|
+
</details>
|
|
294
|
+
<details>
|
|
295
|
+
<summary>
|
|
296
|
+
DeleteBot
|
|
297
|
+
</summary>
|
|
298
|
+
|
|
299
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/DeleteBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteBotCommandOutput/)
|
|
300
|
+
|
|
301
|
+
</details>
|
|
302
|
+
<details>
|
|
303
|
+
<summary>
|
|
304
|
+
DeleteDataRetentionBot
|
|
305
|
+
</summary>
|
|
306
|
+
|
|
307
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/DeleteDataRetentionBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteDataRetentionBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteDataRetentionBotCommandOutput/)
|
|
308
|
+
|
|
309
|
+
</details>
|
|
310
|
+
<details>
|
|
311
|
+
<summary>
|
|
312
|
+
DeleteNetwork
|
|
313
|
+
</summary>
|
|
314
|
+
|
|
315
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/DeleteNetworkCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteNetworkCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteNetworkCommandOutput/)
|
|
316
|
+
|
|
317
|
+
</details>
|
|
318
|
+
<details>
|
|
319
|
+
<summary>
|
|
320
|
+
DeleteSecurityGroup
|
|
321
|
+
</summary>
|
|
322
|
+
|
|
323
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/DeleteSecurityGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteSecurityGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/DeleteSecurityGroupCommandOutput/)
|
|
324
|
+
|
|
325
|
+
</details>
|
|
326
|
+
<details>
|
|
327
|
+
<summary>
|
|
328
|
+
GetBot
|
|
329
|
+
</summary>
|
|
330
|
+
|
|
331
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetBotCommandOutput/)
|
|
332
|
+
|
|
333
|
+
</details>
|
|
334
|
+
<details>
|
|
335
|
+
<summary>
|
|
336
|
+
GetBotsCount
|
|
337
|
+
</summary>
|
|
338
|
+
|
|
339
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetBotsCountCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetBotsCountCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetBotsCountCommandOutput/)
|
|
340
|
+
|
|
341
|
+
</details>
|
|
342
|
+
<details>
|
|
343
|
+
<summary>
|
|
344
|
+
GetDataRetentionBot
|
|
345
|
+
</summary>
|
|
346
|
+
|
|
347
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetDataRetentionBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetDataRetentionBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetDataRetentionBotCommandOutput/)
|
|
348
|
+
|
|
349
|
+
</details>
|
|
350
|
+
<details>
|
|
351
|
+
<summary>
|
|
352
|
+
GetGuestUserHistoryCount
|
|
353
|
+
</summary>
|
|
354
|
+
|
|
355
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetGuestUserHistoryCountCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetGuestUserHistoryCountCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetGuestUserHistoryCountCommandOutput/)
|
|
356
|
+
|
|
357
|
+
</details>
|
|
358
|
+
<details>
|
|
359
|
+
<summary>
|
|
360
|
+
GetNetwork
|
|
361
|
+
</summary>
|
|
362
|
+
|
|
363
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetNetworkCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetNetworkCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetNetworkCommandOutput/)
|
|
364
|
+
|
|
365
|
+
</details>
|
|
366
|
+
<details>
|
|
367
|
+
<summary>
|
|
368
|
+
GetNetworkSettings
|
|
369
|
+
</summary>
|
|
370
|
+
|
|
371
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetNetworkSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetNetworkSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetNetworkSettingsCommandOutput/)
|
|
372
|
+
|
|
373
|
+
</details>
|
|
374
|
+
<details>
|
|
375
|
+
<summary>
|
|
376
|
+
GetOidcInfo
|
|
377
|
+
</summary>
|
|
378
|
+
|
|
379
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetOidcInfoCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetOidcInfoCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetOidcInfoCommandOutput/)
|
|
380
|
+
|
|
381
|
+
</details>
|
|
382
|
+
<details>
|
|
383
|
+
<summary>
|
|
384
|
+
GetSecurityGroup
|
|
385
|
+
</summary>
|
|
386
|
+
|
|
387
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetSecurityGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetSecurityGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetSecurityGroupCommandOutput/)
|
|
388
|
+
|
|
389
|
+
</details>
|
|
390
|
+
<details>
|
|
391
|
+
<summary>
|
|
392
|
+
GetUser
|
|
393
|
+
</summary>
|
|
394
|
+
|
|
395
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetUserCommandOutput/)
|
|
396
|
+
|
|
397
|
+
</details>
|
|
398
|
+
<details>
|
|
399
|
+
<summary>
|
|
400
|
+
GetUsersCount
|
|
401
|
+
</summary>
|
|
402
|
+
|
|
403
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/GetUsersCountCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetUsersCountCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/GetUsersCountCommandOutput/)
|
|
404
|
+
|
|
405
|
+
</details>
|
|
406
|
+
<details>
|
|
407
|
+
<summary>
|
|
408
|
+
ListBlockedGuestUsers
|
|
409
|
+
</summary>
|
|
410
|
+
|
|
411
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListBlockedGuestUsersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListBlockedGuestUsersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListBlockedGuestUsersCommandOutput/)
|
|
412
|
+
|
|
413
|
+
</details>
|
|
414
|
+
<details>
|
|
415
|
+
<summary>
|
|
416
|
+
ListBots
|
|
417
|
+
</summary>
|
|
418
|
+
|
|
419
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListBotsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListBotsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListBotsCommandOutput/)
|
|
420
|
+
|
|
421
|
+
</details>
|
|
422
|
+
<details>
|
|
423
|
+
<summary>
|
|
424
|
+
ListDevicesForUser
|
|
425
|
+
</summary>
|
|
426
|
+
|
|
427
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListDevicesForUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListDevicesForUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListDevicesForUserCommandOutput/)
|
|
428
|
+
|
|
429
|
+
</details>
|
|
430
|
+
<details>
|
|
431
|
+
<summary>
|
|
432
|
+
ListGuestUsers
|
|
433
|
+
</summary>
|
|
434
|
+
|
|
435
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListGuestUsersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListGuestUsersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListGuestUsersCommandOutput/)
|
|
436
|
+
|
|
437
|
+
</details>
|
|
438
|
+
<details>
|
|
439
|
+
<summary>
|
|
440
|
+
ListNetworks
|
|
441
|
+
</summary>
|
|
442
|
+
|
|
443
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListNetworksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListNetworksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListNetworksCommandOutput/)
|
|
444
|
+
|
|
445
|
+
</details>
|
|
446
|
+
<details>
|
|
447
|
+
<summary>
|
|
448
|
+
ListSecurityGroups
|
|
449
|
+
</summary>
|
|
450
|
+
|
|
451
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListSecurityGroupsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListSecurityGroupsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListSecurityGroupsCommandOutput/)
|
|
452
|
+
|
|
453
|
+
</details>
|
|
454
|
+
<details>
|
|
455
|
+
<summary>
|
|
456
|
+
ListSecurityGroupUsers
|
|
457
|
+
</summary>
|
|
458
|
+
|
|
459
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListSecurityGroupUsersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListSecurityGroupUsersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListSecurityGroupUsersCommandOutput/)
|
|
460
|
+
|
|
461
|
+
</details>
|
|
462
|
+
<details>
|
|
463
|
+
<summary>
|
|
464
|
+
ListUsers
|
|
465
|
+
</summary>
|
|
466
|
+
|
|
467
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/ListUsersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListUsersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/ListUsersCommandOutput/)
|
|
468
|
+
|
|
469
|
+
</details>
|
|
470
|
+
<details>
|
|
471
|
+
<summary>
|
|
472
|
+
RegisterOidcConfig
|
|
473
|
+
</summary>
|
|
474
|
+
|
|
475
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/RegisterOidcConfigCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/RegisterOidcConfigCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/RegisterOidcConfigCommandOutput/)
|
|
476
|
+
|
|
477
|
+
</details>
|
|
478
|
+
<details>
|
|
479
|
+
<summary>
|
|
480
|
+
RegisterOidcConfigTest
|
|
481
|
+
</summary>
|
|
482
|
+
|
|
483
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/RegisterOidcConfigTestCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/RegisterOidcConfigTestCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/RegisterOidcConfigTestCommandOutput/)
|
|
484
|
+
|
|
485
|
+
</details>
|
|
486
|
+
<details>
|
|
487
|
+
<summary>
|
|
488
|
+
UpdateBot
|
|
489
|
+
</summary>
|
|
490
|
+
|
|
491
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateBotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateBotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateBotCommandOutput/)
|
|
492
|
+
|
|
493
|
+
</details>
|
|
494
|
+
<details>
|
|
495
|
+
<summary>
|
|
496
|
+
UpdateDataRetention
|
|
497
|
+
</summary>
|
|
498
|
+
|
|
499
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateDataRetentionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateDataRetentionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateDataRetentionCommandOutput/)
|
|
500
|
+
|
|
501
|
+
</details>
|
|
502
|
+
<details>
|
|
503
|
+
<summary>
|
|
504
|
+
UpdateGuestUser
|
|
505
|
+
</summary>
|
|
506
|
+
|
|
507
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateGuestUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateGuestUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateGuestUserCommandOutput/)
|
|
508
|
+
|
|
509
|
+
</details>
|
|
510
|
+
<details>
|
|
511
|
+
<summary>
|
|
512
|
+
UpdateNetwork
|
|
513
|
+
</summary>
|
|
514
|
+
|
|
515
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateNetworkCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateNetworkCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateNetworkCommandOutput/)
|
|
516
|
+
|
|
517
|
+
</details>
|
|
518
|
+
<details>
|
|
519
|
+
<summary>
|
|
520
|
+
UpdateNetworkSettings
|
|
521
|
+
</summary>
|
|
522
|
+
|
|
523
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateNetworkSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateNetworkSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateNetworkSettingsCommandOutput/)
|
|
524
|
+
|
|
525
|
+
</details>
|
|
526
|
+
<details>
|
|
527
|
+
<summary>
|
|
528
|
+
UpdateSecurityGroup
|
|
529
|
+
</summary>
|
|
530
|
+
|
|
531
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateSecurityGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateSecurityGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateSecurityGroupCommandOutput/)
|
|
532
|
+
|
|
533
|
+
</details>
|
|
534
|
+
<details>
|
|
535
|
+
<summary>
|
|
536
|
+
UpdateUser
|
|
537
|
+
</summary>
|
|
538
|
+
|
|
539
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wickr/command/UpdateUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wickr/Interface/UpdateUserCommandOutput/)
|
|
540
|
+
|
|
541
|
+
</details>
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveHttpAuthSchemeConfig = exports.defaultWickrHttpAuthSchemeProvider = exports.defaultWickrHttpAuthSchemeParametersProvider = void 0;
|
|
4
|
+
const core_1 = require("@aws-sdk/core");
|
|
5
|
+
const util_middleware_1 = require("@smithy/util-middleware");
|
|
6
|
+
const defaultWickrHttpAuthSchemeParametersProvider = async (config, context, input) => {
|
|
7
|
+
return {
|
|
8
|
+
operation: (0, util_middleware_1.getSmithyContext)(context).operation,
|
|
9
|
+
region: (await (0, util_middleware_1.normalizeProvider)(config.region)()) ||
|
|
10
|
+
(() => {
|
|
11
|
+
throw new Error("expected `region` to be configured for `aws.auth#sigv4`");
|
|
12
|
+
})(),
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
exports.defaultWickrHttpAuthSchemeParametersProvider = defaultWickrHttpAuthSchemeParametersProvider;
|
|
16
|
+
function createAwsAuthSigv4HttpAuthOption(authParameters) {
|
|
17
|
+
return {
|
|
18
|
+
schemeId: "aws.auth#sigv4",
|
|
19
|
+
signingProperties: {
|
|
20
|
+
name: "wickr",
|
|
21
|
+
region: authParameters.region,
|
|
22
|
+
},
|
|
23
|
+
propertiesExtractor: (config, context) => ({
|
|
24
|
+
signingProperties: {
|
|
25
|
+
config,
|
|
26
|
+
context,
|
|
27
|
+
},
|
|
28
|
+
}),
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
const defaultWickrHttpAuthSchemeProvider = (authParameters) => {
|
|
32
|
+
const options = [];
|
|
33
|
+
switch (authParameters.operation) {
|
|
34
|
+
default: {
|
|
35
|
+
options.push(createAwsAuthSigv4HttpAuthOption(authParameters));
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return options;
|
|
39
|
+
};
|
|
40
|
+
exports.defaultWickrHttpAuthSchemeProvider = defaultWickrHttpAuthSchemeProvider;
|
|
41
|
+
const resolveHttpAuthSchemeConfig = (config) => {
|
|
42
|
+
const config_0 = (0, core_1.resolveAwsSdkSigV4Config)(config);
|
|
43
|
+
return Object.assign(config_0, {
|
|
44
|
+
authSchemePreference: (0, util_middleware_1.normalizeProvider)(config.authSchemePreference ?? []),
|
|
45
|
+
});
|
|
46
|
+
};
|
|
47
|
+
exports.resolveHttpAuthSchemeConfig = resolveHttpAuthSchemeConfig;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.defaultEndpointResolver = void 0;
|
|
4
|
+
const util_endpoints_1 = require("@aws-sdk/util-endpoints");
|
|
5
|
+
const util_endpoints_2 = require("@smithy/util-endpoints");
|
|
6
|
+
const ruleset_1 = require("./ruleset");
|
|
7
|
+
const cache = new util_endpoints_2.EndpointCache({
|
|
8
|
+
size: 50,
|
|
9
|
+
params: ["Endpoint", "Region", "UseDualStack", "UseFIPS"],
|
|
10
|
+
});
|
|
11
|
+
const defaultEndpointResolver = (endpointParams, context = {}) => {
|
|
12
|
+
return cache.get(endpointParams, () => (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
|
|
13
|
+
endpointParams: endpointParams,
|
|
14
|
+
logger: context.logger,
|
|
15
|
+
}));
|
|
16
|
+
};
|
|
17
|
+
exports.defaultEndpointResolver = defaultEndpointResolver;
|
|
18
|
+
util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ruleSet = void 0;
|
|
4
|
+
const s = "required", t = "fn", u = "argv", v = "ref";
|
|
5
|
+
const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [s]: false, "type": "string" }, i = { [s]: true, "default": false, "type": "boolean" }, j = { [v]: "Endpoint" }, k = { [t]: c, [u]: [{ [v]: "UseFIPS" }, true] }, l = { [t]: c, [u]: [{ [v]: "UseDualStack" }, true] }, m = {}, n = { [t]: "getAttr", [u]: [{ [v]: g }, "supportsFIPS"] }, o = { [t]: c, [u]: [true, { [t]: "getAttr", [u]: [{ [v]: g }, "supportsDualStack"] }] }, p = [k], q = [l], r = [{ [v]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: h, UseDualStack: i, UseFIPS: i, Endpoint: h }, rules: [{ conditions: [{ [t]: b, [u]: [j] }], rules: [{ conditions: p, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: d }, { rules: [{ conditions: q, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: d }, { endpoint: { url: j, properties: m, headers: m }, type: e }], type: f }], type: f }, { rules: [{ conditions: [{ [t]: b, [u]: r }], rules: [{ conditions: [{ [t]: "aws.partition", [u]: r, assign: g }], rules: [{ conditions: [k, l], rules: [{ conditions: [{ [t]: c, [u]: [a, n] }, o], rules: [{ rules: [{ endpoint: { url: "https://admin.wickr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: d }], type: f }, { conditions: p, rules: [{ conditions: [{ [t]: c, [u]: [n, a] }], rules: [{ rules: [{ endpoint: { url: "https://admin.wickr-fips.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS is enabled but this partition does not support FIPS", type: d }], type: f }, { conditions: q, rules: [{ conditions: [o], rules: [{ rules: [{ endpoint: { url: "https://admin.wickr.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "DualStack is enabled but this partition does not support DualStack", type: d }], type: f }, { rules: [{ endpoint: { url: "https://admin.wickr.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }], type: f }, { error: "Invalid Configuration: Missing Region", type: d }], type: f }] };
|
|
7
|
+
exports.ruleSet = _data;
|