@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
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CreateBotRequest, CreateBotResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateBotCommandInput extends CreateBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateBotCommandOutput extends CreateBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateBotCommand_base: {
|
|
25
|
+
new (input: CreateBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotCommandInput, CreateBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotCommandInput, CreateBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, CreateBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, CreateBotCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // CreateBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* username: "STRING_VALUE", // required
|
|
42
|
+
* displayName: "STRING_VALUE",
|
|
43
|
+
* groupId: "STRING_VALUE", // required
|
|
44
|
+
* challenge: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CreateBotCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // CreateBotResponse
|
|
49
|
+
* // message: "STRING_VALUE",
|
|
50
|
+
* // botId: "STRING_VALUE", // required
|
|
51
|
+
* // networkId: "STRING_VALUE",
|
|
52
|
+
* // username: "STRING_VALUE",
|
|
53
|
+
* // displayName: "STRING_VALUE",
|
|
54
|
+
* // groupId: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param CreateBotCommandInput - {@link CreateBotCommandInput}
|
|
60
|
+
* @returns {@link CreateBotCommandOutput}
|
|
61
|
+
* @see {@link CreateBotCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link CreateBotCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link BadRequestError} (client fault)
|
|
66
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
69
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerError} (server fault)
|
|
72
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link RateLimitError} (client fault)
|
|
75
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
78
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
81
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ValidationError} (client fault)
|
|
84
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link WickrServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @example Create bot successfully
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* challenge: "SecureP@ssw0rd123",
|
|
95
|
+
* displayName: "Analytics Bot",
|
|
96
|
+
* groupId: "analytics_group",
|
|
97
|
+
* networkId: "12345678",
|
|
98
|
+
* username: "analytics_bot"
|
|
99
|
+
* };
|
|
100
|
+
* const command = new CreateBotCommand(input);
|
|
101
|
+
* const response = await client.send(command);
|
|
102
|
+
* /* response is
|
|
103
|
+
* {
|
|
104
|
+
* botId: "98766",
|
|
105
|
+
* displayName: "Analytics Bot",
|
|
106
|
+
* groupId: "analytics_group",
|
|
107
|
+
* networkId: "12345678",
|
|
108
|
+
* username: "analytics_bot"
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @example Create bot - username unavailable
|
|
114
|
+
* ```javascript
|
|
115
|
+
* //
|
|
116
|
+
* const input = {
|
|
117
|
+
* challenge: "SecureP@ssw0rd123",
|
|
118
|
+
* displayName: "Support Bot",
|
|
119
|
+
* groupId: "default_group",
|
|
120
|
+
* networkId: "12345678",
|
|
121
|
+
* username: "support_bot"
|
|
122
|
+
* };
|
|
123
|
+
* const command = new CreateBotCommand(input);
|
|
124
|
+
* const response = await client.send(command);
|
|
125
|
+
* /* response is
|
|
126
|
+
* { /* metadata only *\/ }
|
|
127
|
+
* *\/
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @example Create bot - invalid username format
|
|
131
|
+
* ```javascript
|
|
132
|
+
* //
|
|
133
|
+
* const input = {
|
|
134
|
+
* challenge: "SecureP@ssw0rd123",
|
|
135
|
+
* displayName: "Test Bot",
|
|
136
|
+
* groupId: "default_group",
|
|
137
|
+
* networkId: "12345678",
|
|
138
|
+
* username: "bot@invalid"
|
|
139
|
+
* };
|
|
140
|
+
* const command = new CreateBotCommand(input);
|
|
141
|
+
* const response = await client.send(command);
|
|
142
|
+
* /* response is
|
|
143
|
+
* { /* metadata only *\/ }
|
|
144
|
+
* *\/
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
export declare class CreateBotCommand extends CreateBotCommand_base {
|
|
150
|
+
/** @internal type navigation helper, not in runtime. */
|
|
151
|
+
protected static __types: {
|
|
152
|
+
api: {
|
|
153
|
+
input: CreateBotRequest;
|
|
154
|
+
output: CreateBotResponse;
|
|
155
|
+
};
|
|
156
|
+
sdk: {
|
|
157
|
+
input: CreateBotCommandInput;
|
|
158
|
+
output: CreateBotCommandOutput;
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CreateDataRetentionBotChallengeRequest, CreateDataRetentionBotChallengeResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateDataRetentionBotChallengeCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateDataRetentionBotChallengeCommandInput extends CreateDataRetentionBotChallengeRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateDataRetentionBotChallengeCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateDataRetentionBotChallengeCommandOutput extends CreateDataRetentionBotChallengeResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateDataRetentionBotChallengeCommand_base: {
|
|
25
|
+
new (input: CreateDataRetentionBotChallengeCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataRetentionBotChallengeCommandInput, CreateDataRetentionBotChallengeCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateDataRetentionBotChallengeCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataRetentionBotChallengeCommandInput, CreateDataRetentionBotChallengeCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, CreateDataRetentionBotChallengeCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, CreateDataRetentionBotChallengeCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // CreateDataRetentionBotChallengeRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new CreateDataRetentionBotChallengeCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // CreateDataRetentionBotChallengeResponse
|
|
45
|
+
* // challenge: "STRING_VALUE", // required
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param CreateDataRetentionBotChallengeCommandInput - {@link CreateDataRetentionBotChallengeCommandInput}
|
|
51
|
+
* @returns {@link CreateDataRetentionBotChallengeCommandOutput}
|
|
52
|
+
* @see {@link CreateDataRetentionBotChallengeCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link CreateDataRetentionBotChallengeCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link BadRequestError} (client fault)
|
|
57
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
60
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerError} (server fault)
|
|
63
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link RateLimitError} (client fault)
|
|
66
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
69
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
72
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationError} (client fault)
|
|
75
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link WickrServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @example Create data retention bot challenge successfully
|
|
82
|
+
* ```javascript
|
|
83
|
+
* //
|
|
84
|
+
* const input = {
|
|
85
|
+
* networkId: "12345678"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new CreateDataRetentionBotChallengeCommand(input);
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response is
|
|
90
|
+
* {
|
|
91
|
+
* challenge: "a1b2c3d4e5f6"
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class CreateDataRetentionBotChallengeCommand extends CreateDataRetentionBotChallengeCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: CreateDataRetentionBotChallengeRequest;
|
|
103
|
+
output: CreateDataRetentionBotChallengeResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: CreateDataRetentionBotChallengeCommandInput;
|
|
107
|
+
output: CreateDataRetentionBotChallengeCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CreateDataRetentionBotRequest, CreateDataRetentionBotResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateDataRetentionBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateDataRetentionBotCommandInput extends CreateDataRetentionBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateDataRetentionBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateDataRetentionBotCommandOutput extends CreateDataRetentionBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateDataRetentionBotCommand_base: {
|
|
25
|
+
new (input: CreateDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataRetentionBotCommandInput, CreateDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDataRetentionBotCommandInput, CreateDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, CreateDataRetentionBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, CreateDataRetentionBotCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // CreateDataRetentionBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new CreateDataRetentionBotCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // CreateDataRetentionBotResponse
|
|
45
|
+
* // message: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param CreateDataRetentionBotCommandInput - {@link CreateDataRetentionBotCommandInput}
|
|
51
|
+
* @returns {@link CreateDataRetentionBotCommandOutput}
|
|
52
|
+
* @see {@link CreateDataRetentionBotCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link CreateDataRetentionBotCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link BadRequestError} (client fault)
|
|
57
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
60
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerError} (server fault)
|
|
63
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link RateLimitError} (client fault)
|
|
66
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
69
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
72
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationError} (client fault)
|
|
75
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link WickrServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @example Create data retention bot successfully
|
|
82
|
+
* ```javascript
|
|
83
|
+
* //
|
|
84
|
+
* const input = {
|
|
85
|
+
* networkId: "12345678"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new CreateDataRetentionBotCommand(input);
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response is
|
|
90
|
+
* {
|
|
91
|
+
* message: "successfully provisioned data retention bot"
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @example Create data retention bot - users already exist
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* networkId: "12345678"
|
|
101
|
+
* };
|
|
102
|
+
* const command = new CreateDataRetentionBotCommand(input);
|
|
103
|
+
* const response = await client.send(command);
|
|
104
|
+
* /* response is
|
|
105
|
+
* { /* metadata only *\/ }
|
|
106
|
+
* *\/
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class CreateDataRetentionBotCommand extends CreateDataRetentionBotCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: CreateDataRetentionBotRequest;
|
|
116
|
+
output: CreateDataRetentionBotResponse;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: CreateDataRetentionBotCommandInput;
|
|
120
|
+
output: CreateDataRetentionBotCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CreateNetworkRequest, CreateNetworkResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateNetworkCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateNetworkCommandInput extends CreateNetworkRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateNetworkCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateNetworkCommandOutput extends CreateNetworkResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateNetworkCommand_base: {
|
|
25
|
+
new (input: CreateNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<CreateNetworkCommandInput, CreateNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<CreateNetworkCommandInput, CreateNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, CreateNetworkCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, CreateNetworkCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // CreateNetworkRequest
|
|
40
|
+
* networkName: "STRING_VALUE", // required
|
|
41
|
+
* accessLevel: "STANDARD" || "PREMIUM", // required
|
|
42
|
+
* enablePremiumFreeTrial: true || false,
|
|
43
|
+
* encryptionKeyArn: "STRING_VALUE",
|
|
44
|
+
* };
|
|
45
|
+
* const command = new CreateNetworkCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // CreateNetworkResponse
|
|
48
|
+
* // networkId: "STRING_VALUE",
|
|
49
|
+
* // networkName: "STRING_VALUE",
|
|
50
|
+
* // encryptionKeyArn: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param CreateNetworkCommandInput - {@link CreateNetworkCommandInput}
|
|
56
|
+
* @returns {@link CreateNetworkCommandOutput}
|
|
57
|
+
* @see {@link CreateNetworkCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link CreateNetworkCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link BadRequestError} (client fault)
|
|
62
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
65
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerError} (server fault)
|
|
68
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link RateLimitError} (client fault)
|
|
71
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
74
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
77
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationError} (client fault)
|
|
80
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link WickrServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @example Create network successfully
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* accessLevel: "PREMIUM",
|
|
91
|
+
* enablePremiumFreeTrial: false,
|
|
92
|
+
* networkName: "Production Network"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new CreateNetworkCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response is
|
|
97
|
+
* {
|
|
98
|
+
* networkId: "12345678",
|
|
99
|
+
* networkName: "Production Network"
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* @example Create network with free trial
|
|
105
|
+
* ```javascript
|
|
106
|
+
* //
|
|
107
|
+
* const input = {
|
|
108
|
+
* accessLevel: "PREMIUM",
|
|
109
|
+
* enablePremiumFreeTrial: true,
|
|
110
|
+
* networkName: "Trial Network"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new CreateNetworkCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* networkId: "87654321",
|
|
117
|
+
* networkName: "Trial Network"
|
|
118
|
+
* }
|
|
119
|
+
* *\/
|
|
120
|
+
* ```
|
|
121
|
+
*
|
|
122
|
+
* @example Create network - invalid name
|
|
123
|
+
* ```javascript
|
|
124
|
+
* //
|
|
125
|
+
* const input = {
|
|
126
|
+
* accessLevel: "STANDARD",
|
|
127
|
+
* networkName: "This network name is way too long"
|
|
128
|
+
* };
|
|
129
|
+
* const command = new CreateNetworkCommand(input);
|
|
130
|
+
* const response = await client.send(command);
|
|
131
|
+
* /* response is
|
|
132
|
+
* { /* metadata only *\/ }
|
|
133
|
+
* *\/
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export declare class CreateNetworkCommand extends CreateNetworkCommand_base {
|
|
139
|
+
/** @internal type navigation helper, not in runtime. */
|
|
140
|
+
protected static __types: {
|
|
141
|
+
api: {
|
|
142
|
+
input: CreateNetworkRequest;
|
|
143
|
+
output: CreateNetworkResponse;
|
|
144
|
+
};
|
|
145
|
+
sdk: {
|
|
146
|
+
input: CreateNetworkCommandInput;
|
|
147
|
+
output: CreateNetworkCommandOutput;
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
}
|