@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,241 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CreateSecurityGroupRequest, CreateSecurityGroupResponse } 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 CreateSecurityGroupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateSecurityGroupCommandInput extends CreateSecurityGroupRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateSecurityGroupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateSecurityGroupCommandOutput extends CreateSecurityGroupResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateSecurityGroupCommand_base: {
|
|
25
|
+
new (input: CreateSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSecurityGroupCommandInput, CreateSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSecurityGroupCommandInput, CreateSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, CreateSecurityGroupCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, CreateSecurityGroupCommand } = 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 = { // CreateSecurityGroupRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* name: "STRING_VALUE", // required
|
|
42
|
+
* securityGroupSettings: { // SecurityGroupSettingsRequest
|
|
43
|
+
* lockoutThreshold: Number("int"),
|
|
44
|
+
* permittedNetworks: [ // PermittedNetworksList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* enableGuestFederation: true || false,
|
|
48
|
+
* globalFederation: true || false,
|
|
49
|
+
* federationMode: Number("int"),
|
|
50
|
+
* enableRestrictedGlobalFederation: true || false,
|
|
51
|
+
* permittedWickrAwsNetworks: [ // WickrAwsNetworksList
|
|
52
|
+
* { // WickrAwsNetworks
|
|
53
|
+
* region: "STRING_VALUE", // required
|
|
54
|
+
* networkId: "STRING_VALUE", // required
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
|
|
58
|
+
* { // PermittedWickrEnterpriseNetwork
|
|
59
|
+
* domain: "STRING_VALUE", // required
|
|
60
|
+
* networkId: "STRING_VALUE", // required
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
63
|
+
* },
|
|
64
|
+
* clientToken: "STRING_VALUE",
|
|
65
|
+
* };
|
|
66
|
+
* const command = new CreateSecurityGroupCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* // { // CreateSecurityGroupResponse
|
|
69
|
+
* // securityGroup: { // SecurityGroup
|
|
70
|
+
* // activeMembers: Number("int"), // required
|
|
71
|
+
* // botMembers: Number("int"), // required
|
|
72
|
+
* // activeDirectoryGuid: "STRING_VALUE",
|
|
73
|
+
* // id: "STRING_VALUE", // required
|
|
74
|
+
* // isDefault: true || false, // required
|
|
75
|
+
* // name: "STRING_VALUE", // required
|
|
76
|
+
* // modified: Number("int"), // required
|
|
77
|
+
* // securityGroupSettings: { // SecurityGroupSettings
|
|
78
|
+
* // alwaysReauthenticate: true || false,
|
|
79
|
+
* // atakPackageValues: [ // SecurityGroupStringList
|
|
80
|
+
* // "STRING_VALUE",
|
|
81
|
+
* // ],
|
|
82
|
+
* // calling: { // CallingSettings
|
|
83
|
+
* // canStart11Call: true || false,
|
|
84
|
+
* // canVideoCall: true || false,
|
|
85
|
+
* // forceTcpCall: true || false,
|
|
86
|
+
* // },
|
|
87
|
+
* // checkForUpdates: true || false,
|
|
88
|
+
* // enableAtak: true || false,
|
|
89
|
+
* // enableCrashReports: true || false,
|
|
90
|
+
* // enableFileDownload: true || false,
|
|
91
|
+
* // enableGuestFederation: true || false,
|
|
92
|
+
* // enableNotificationPreview: true || false,
|
|
93
|
+
* // enableOpenAccessOption: true || false,
|
|
94
|
+
* // enableRestrictedGlobalFederation: true || false,
|
|
95
|
+
* // filesEnabled: true || false,
|
|
96
|
+
* // forceDeviceLockout: Number("int"),
|
|
97
|
+
* // forceOpenAccess: true || false,
|
|
98
|
+
* // forceReadReceipts: true || false,
|
|
99
|
+
* // globalFederation: true || false,
|
|
100
|
+
* // isAtoEnabled: true || false,
|
|
101
|
+
* // isLinkPreviewEnabled: true || false,
|
|
102
|
+
* // locationAllowMaps: true || false,
|
|
103
|
+
* // locationEnabled: true || false,
|
|
104
|
+
* // maxAutoDownloadSize: Number("long"),
|
|
105
|
+
* // maxBor: Number("int"),
|
|
106
|
+
* // maxTtl: Number("long"),
|
|
107
|
+
* // messageForwardingEnabled: true || false,
|
|
108
|
+
* // passwordRequirements: { // PasswordRequirements
|
|
109
|
+
* // lowercase: Number("int"),
|
|
110
|
+
* // minLength: Number("int"),
|
|
111
|
+
* // numbers: Number("int"),
|
|
112
|
+
* // symbols: Number("int"),
|
|
113
|
+
* // uppercase: Number("int"),
|
|
114
|
+
* // },
|
|
115
|
+
* // presenceEnabled: true || false,
|
|
116
|
+
* // quickResponses: [
|
|
117
|
+
* // "STRING_VALUE",
|
|
118
|
+
* // ],
|
|
119
|
+
* // showMasterRecoveryKey: true || false,
|
|
120
|
+
* // shredder: { // ShredderSettings
|
|
121
|
+
* // canProcessManually: true || false,
|
|
122
|
+
* // intensity: Number("int"),
|
|
123
|
+
* // },
|
|
124
|
+
* // ssoMaxIdleMinutes: Number("int"),
|
|
125
|
+
* // federationMode: Number("int"),
|
|
126
|
+
* // lockoutThreshold: Number("int"),
|
|
127
|
+
* // permittedNetworks: [ // PermittedNetworksList
|
|
128
|
+
* // "STRING_VALUE",
|
|
129
|
+
* // ],
|
|
130
|
+
* // permittedWickrAwsNetworks: [ // WickrAwsNetworksList
|
|
131
|
+
* // { // WickrAwsNetworks
|
|
132
|
+
* // region: "STRING_VALUE", // required
|
|
133
|
+
* // networkId: "STRING_VALUE", // required
|
|
134
|
+
* // },
|
|
135
|
+
* // ],
|
|
136
|
+
* // permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
|
|
137
|
+
* // { // PermittedWickrEnterpriseNetwork
|
|
138
|
+
* // domain: "STRING_VALUE", // required
|
|
139
|
+
* // networkId: "STRING_VALUE", // required
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // },
|
|
143
|
+
* // },
|
|
144
|
+
* // };
|
|
145
|
+
*
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
148
|
+
* @param CreateSecurityGroupCommandInput - {@link CreateSecurityGroupCommandInput}
|
|
149
|
+
* @returns {@link CreateSecurityGroupCommandOutput}
|
|
150
|
+
* @see {@link CreateSecurityGroupCommandInput} for command's `input` shape.
|
|
151
|
+
* @see {@link CreateSecurityGroupCommandOutput} for command's `response` shape.
|
|
152
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link BadRequestError} (client fault)
|
|
155
|
+
* <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>
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
158
|
+
* <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>
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link InternalServerError} (server fault)
|
|
161
|
+
* <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>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link RateLimitError} (client fault)
|
|
164
|
+
* <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>
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
167
|
+
* <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>
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
170
|
+
* <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>
|
|
171
|
+
*
|
|
172
|
+
* @throws {@link ValidationError} (client fault)
|
|
173
|
+
* <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>
|
|
174
|
+
*
|
|
175
|
+
* @throws {@link WickrServiceException}
|
|
176
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
177
|
+
*
|
|
178
|
+
*
|
|
179
|
+
* @example Create security group successfully
|
|
180
|
+
* ```javascript
|
|
181
|
+
* //
|
|
182
|
+
* const input = {
|
|
183
|
+
* name: "engineering",
|
|
184
|
+
* networkId: "12345678",
|
|
185
|
+
* securityGroupSettings: {
|
|
186
|
+
* federationMode: 1,
|
|
187
|
+
* lockoutThreshold: 10
|
|
188
|
+
* }
|
|
189
|
+
* };
|
|
190
|
+
* const command = new CreateSecurityGroupCommand(input);
|
|
191
|
+
* const response = await client.send(command);
|
|
192
|
+
* /* response is
|
|
193
|
+
* {
|
|
194
|
+
* securityGroup: {
|
|
195
|
+
* activeMembers: 0,
|
|
196
|
+
* botMembers: 0,
|
|
197
|
+
* id: "def67890",
|
|
198
|
+
* isDefault: false,
|
|
199
|
+
* modified: 1638360000,
|
|
200
|
+
* name: "engineering",
|
|
201
|
+
* securityGroupSettings: {
|
|
202
|
+
* federationMode: 1,
|
|
203
|
+
* lockoutThreshold: 10
|
|
204
|
+
* }
|
|
205
|
+
* }
|
|
206
|
+
* }
|
|
207
|
+
* *\/
|
|
208
|
+
* ```
|
|
209
|
+
*
|
|
210
|
+
* @example Create security group - missing name
|
|
211
|
+
* ```javascript
|
|
212
|
+
* //
|
|
213
|
+
* const input = {
|
|
214
|
+
* name: "",
|
|
215
|
+
* networkId: "12345678",
|
|
216
|
+
* securityGroupSettings: {
|
|
217
|
+
* federationMode: 1
|
|
218
|
+
* }
|
|
219
|
+
* };
|
|
220
|
+
* const command = new CreateSecurityGroupCommand(input);
|
|
221
|
+
* const response = await client.send(command);
|
|
222
|
+
* /* response is
|
|
223
|
+
* { /* metadata only *\/ }
|
|
224
|
+
* *\/
|
|
225
|
+
* ```
|
|
226
|
+
*
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
export declare class CreateSecurityGroupCommand extends CreateSecurityGroupCommand_base {
|
|
230
|
+
/** @internal type navigation helper, not in runtime. */
|
|
231
|
+
protected static __types: {
|
|
232
|
+
api: {
|
|
233
|
+
input: CreateSecurityGroupRequest;
|
|
234
|
+
output: CreateSecurityGroupResponse;
|
|
235
|
+
};
|
|
236
|
+
sdk: {
|
|
237
|
+
input: CreateSecurityGroupCommandInput;
|
|
238
|
+
output: CreateSecurityGroupCommandOutput;
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DeleteBotRequest, DeleteBotResponse } 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 DeleteBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteBotCommandInput extends DeleteBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteBotCommandOutput extends DeleteBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteBotCommand_base: {
|
|
25
|
+
new (input: DeleteBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotCommandInput, DeleteBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotCommandInput, DeleteBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from 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, DeleteBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, DeleteBotCommand } = 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 = { // DeleteBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* botId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteBotCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DeleteBotResponse
|
|
46
|
+
* // message: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param DeleteBotCommandInput - {@link DeleteBotCommandInput}
|
|
52
|
+
* @returns {@link DeleteBotCommandOutput}
|
|
53
|
+
* @see {@link DeleteBotCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link DeleteBotCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link BadRequestError} (client fault)
|
|
58
|
+
* <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>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
61
|
+
* <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>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerError} (server fault)
|
|
64
|
+
* <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>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link RateLimitError} (client fault)
|
|
67
|
+
* <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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationError} (client fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link WickrServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @example Delete bot successfully
|
|
83
|
+
* ```javascript
|
|
84
|
+
* //
|
|
85
|
+
* const input = {
|
|
86
|
+
* botId: "98765",
|
|
87
|
+
* networkId: "12345678"
|
|
88
|
+
* };
|
|
89
|
+
* const command = new DeleteBotCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* {
|
|
93
|
+
* message: "success"
|
|
94
|
+
* }
|
|
95
|
+
* *\/
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @example Delete bot - bot not found
|
|
99
|
+
* ```javascript
|
|
100
|
+
* //
|
|
101
|
+
* const input = {
|
|
102
|
+
* botId: "99999",
|
|
103
|
+
* networkId: "12345678"
|
|
104
|
+
* };
|
|
105
|
+
* const command = new DeleteBotCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response is
|
|
108
|
+
* { /* metadata only *\/ }
|
|
109
|
+
* *\/
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export declare class DeleteBotCommand extends DeleteBotCommand_base {
|
|
115
|
+
/** @internal type navigation helper, not in runtime. */
|
|
116
|
+
protected static __types: {
|
|
117
|
+
api: {
|
|
118
|
+
input: DeleteBotRequest;
|
|
119
|
+
output: DeleteBotResponse;
|
|
120
|
+
};
|
|
121
|
+
sdk: {
|
|
122
|
+
input: DeleteBotCommandInput;
|
|
123
|
+
output: DeleteBotCommandOutput;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
}
|
|
@@ -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 { DeleteDataRetentionBotRequest, DeleteDataRetentionBotResponse } 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 DeleteDataRetentionBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteDataRetentionBotCommandInput extends DeleteDataRetentionBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteDataRetentionBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteDataRetentionBotCommandOutput extends DeleteDataRetentionBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteDataRetentionBotCommand_base: {
|
|
25
|
+
new (input: DeleteDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataRetentionBotCommandInput, DeleteDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataRetentionBotCommandInput, DeleteDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, DeleteDataRetentionBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, DeleteDataRetentionBotCommand } = 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 = { // DeleteDataRetentionBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteDataRetentionBotCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DeleteDataRetentionBotResponse
|
|
45
|
+
* // message: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param DeleteDataRetentionBotCommandInput - {@link DeleteDataRetentionBotCommandInput}
|
|
51
|
+
* @returns {@link DeleteDataRetentionBotCommandOutput}
|
|
52
|
+
* @see {@link DeleteDataRetentionBotCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link DeleteDataRetentionBotCommandOutput} 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 Delete data retention bot successfully
|
|
82
|
+
* ```javascript
|
|
83
|
+
* //
|
|
84
|
+
* const input = {
|
|
85
|
+
* networkId: "12345678"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new DeleteDataRetentionBotCommand(input);
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response is
|
|
90
|
+
* {
|
|
91
|
+
* message: "deleted data retention bot and all associated data from the database"
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class DeleteDataRetentionBotCommand extends DeleteDataRetentionBotCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: DeleteDataRetentionBotRequest;
|
|
103
|
+
output: DeleteDataRetentionBotResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: DeleteDataRetentionBotCommandInput;
|
|
107
|
+
output: DeleteDataRetentionBotCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DeleteNetworkRequest, DeleteNetworkResponse } 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 DeleteNetworkCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteNetworkCommandInput extends DeleteNetworkRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteNetworkCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteNetworkCommandOutput extends DeleteNetworkResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteNetworkCommand_base: {
|
|
25
|
+
new (input: DeleteNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteNetworkCommandInput, DeleteNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteNetworkCommandInput, DeleteNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, DeleteNetworkCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, DeleteNetworkCommand } = 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 = { // DeleteNetworkRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteNetworkCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DeleteNetworkResponse
|
|
46
|
+
* // message: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param DeleteNetworkCommandInput - {@link DeleteNetworkCommandInput}
|
|
52
|
+
* @returns {@link DeleteNetworkCommandOutput}
|
|
53
|
+
* @see {@link DeleteNetworkCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link DeleteNetworkCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link BadRequestError} (client fault)
|
|
58
|
+
* <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>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
61
|
+
* <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>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerError} (server fault)
|
|
64
|
+
* <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>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link RateLimitError} (client fault)
|
|
67
|
+
* <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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationError} (client fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link WickrServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @example Delete network successfully
|
|
83
|
+
* ```javascript
|
|
84
|
+
* //
|
|
85
|
+
* const input = {
|
|
86
|
+
* networkId: "12345678"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new DeleteNetworkCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response is
|
|
91
|
+
* {
|
|
92
|
+
* message: "Network deletion initiated successfully"
|
|
93
|
+
* }
|
|
94
|
+
* *\/
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
97
|
+
* @example Delete network - not found
|
|
98
|
+
* ```javascript
|
|
99
|
+
* //
|
|
100
|
+
* const input = {
|
|
101
|
+
* networkId: "99999999"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new DeleteNetworkCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* { /* metadata only *\/ }
|
|
107
|
+
* *\/
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare class DeleteNetworkCommand extends DeleteNetworkCommand_base {
|
|
113
|
+
/** @internal type navigation helper, not in runtime. */
|
|
114
|
+
protected static __types: {
|
|
115
|
+
api: {
|
|
116
|
+
input: DeleteNetworkRequest;
|
|
117
|
+
output: DeleteNetworkResponse;
|
|
118
|
+
};
|
|
119
|
+
sdk: {
|
|
120
|
+
input: DeleteNetworkCommandInput;
|
|
121
|
+
output: DeleteNetworkCommandOutput;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
}
|