@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,142 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateNetworkRequest, UpdateNetworkResponse } 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 UpdateNetworkCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateNetworkCommandInput extends UpdateNetworkRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateNetworkCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateNetworkCommandOutput extends UpdateNetworkResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateNetworkCommand_base: {
|
|
25
|
+
new (input: UpdateNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNetworkCommandInput, UpdateNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNetworkCommandInput, UpdateNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the properties of an existing Wickr network, such as its name or encryption key configuration.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, UpdateNetworkCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateNetworkCommand } = 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 = { // UpdateNetworkRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* networkName: "STRING_VALUE", // required
|
|
42
|
+
* clientToken: "STRING_VALUE",
|
|
43
|
+
* encryptionKeyArn: "STRING_VALUE",
|
|
44
|
+
* };
|
|
45
|
+
* const command = new UpdateNetworkCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // UpdateNetworkResponse
|
|
48
|
+
* // message: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param UpdateNetworkCommandInput - {@link UpdateNetworkCommandInput}
|
|
54
|
+
* @returns {@link UpdateNetworkCommandOutput}
|
|
55
|
+
* @see {@link UpdateNetworkCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link UpdateNetworkCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link BadRequestError} (client fault)
|
|
60
|
+
* <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>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
63
|
+
* <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>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* <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>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link RateLimitError} (client fault)
|
|
69
|
+
* <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>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
72
|
+
* <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>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
75
|
+
* <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>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationError} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link WickrServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @example Update network name successfully
|
|
85
|
+
* ```javascript
|
|
86
|
+
* //
|
|
87
|
+
* const input = {
|
|
88
|
+
* networkId: "12345678",
|
|
89
|
+
* networkName: "Updated Network Name"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new UpdateNetworkCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* message: "Network updated successfully"
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* @example Update network - invalid name
|
|
101
|
+
* ```javascript
|
|
102
|
+
* //
|
|
103
|
+
* const input = {
|
|
104
|
+
* networkId: "12345678",
|
|
105
|
+
* networkName: "This name is way too long for a network"
|
|
106
|
+
* };
|
|
107
|
+
* const command = new UpdateNetworkCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response is
|
|
110
|
+
* { /* metadata only *\/ }
|
|
111
|
+
* *\/
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* @example Update network - not found
|
|
115
|
+
* ```javascript
|
|
116
|
+
* //
|
|
117
|
+
* const input = {
|
|
118
|
+
* networkId: "99999999",
|
|
119
|
+
* networkName: "New Name"
|
|
120
|
+
* };
|
|
121
|
+
* const command = new UpdateNetworkCommand(input);
|
|
122
|
+
* const response = await client.send(command);
|
|
123
|
+
* /* response is
|
|
124
|
+
* { /* metadata only *\/ }
|
|
125
|
+
* *\/
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export declare class UpdateNetworkCommand extends UpdateNetworkCommand_base {
|
|
131
|
+
/** @internal type navigation helper, not in runtime. */
|
|
132
|
+
protected static __types: {
|
|
133
|
+
api: {
|
|
134
|
+
input: UpdateNetworkRequest;
|
|
135
|
+
output: UpdateNetworkResponse;
|
|
136
|
+
};
|
|
137
|
+
sdk: {
|
|
138
|
+
input: UpdateNetworkCommandInput;
|
|
139
|
+
output: UpdateNetworkCommandOutput;
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
}
|
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateNetworkSettingsRequest, UpdateNetworkSettingsResponse } 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 UpdateNetworkSettingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateNetworkSettingsCommandInput extends UpdateNetworkSettingsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateNetworkSettingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateNetworkSettingsCommandOutput extends UpdateNetworkSettingsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateNetworkSettingsCommand_base: {
|
|
25
|
+
new (input: UpdateNetworkSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNetworkSettingsCommandInput, UpdateNetworkSettingsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateNetworkSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNetworkSettingsCommandInput, UpdateNetworkSettingsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, UpdateNetworkSettingsCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateNetworkSettingsCommand } = 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 = { // UpdateNetworkSettingsRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* settings: { // NetworkSettings
|
|
42
|
+
* enableClientMetrics: true || false,
|
|
43
|
+
* readReceiptConfig: { // ReadReceiptConfig
|
|
44
|
+
* status: "DISABLED" || "ENABLED" || "FORCE_ENABLED",
|
|
45
|
+
* },
|
|
46
|
+
* dataRetention: true || false,
|
|
47
|
+
* },
|
|
48
|
+
* };
|
|
49
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // UpdateNetworkSettingsResponse
|
|
52
|
+
* // settings: [ // SettingsList // required
|
|
53
|
+
* // { // Setting
|
|
54
|
+
* // optionName: "STRING_VALUE", // required
|
|
55
|
+
* // value: "STRING_VALUE", // required
|
|
56
|
+
* // type: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param UpdateNetworkSettingsCommandInput - {@link UpdateNetworkSettingsCommandInput}
|
|
64
|
+
* @returns {@link UpdateNetworkSettingsCommandOutput}
|
|
65
|
+
* @see {@link UpdateNetworkSettingsCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link UpdateNetworkSettingsCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link BadRequestError} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerError} (server fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link RateLimitError} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ValidationError} (client fault)
|
|
88
|
+
* <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>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link WickrServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @example Update multiple network settings
|
|
95
|
+
* ```javascript
|
|
96
|
+
* //
|
|
97
|
+
* const input = {
|
|
98
|
+
* networkId: "12345678",
|
|
99
|
+
* settings: {
|
|
100
|
+
* dataRetention: true,
|
|
101
|
+
* enableClientMetrics: true
|
|
102
|
+
* }
|
|
103
|
+
* };
|
|
104
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response is
|
|
107
|
+
* {
|
|
108
|
+
* settings: [
|
|
109
|
+
* {
|
|
110
|
+
* optionName: "enableClientMetrics",
|
|
111
|
+
* type: "boolean",
|
|
112
|
+
* value: "true"
|
|
113
|
+
* },
|
|
114
|
+
* {
|
|
115
|
+
* optionName: "dataRetention",
|
|
116
|
+
* type: "boolean",
|
|
117
|
+
* value: "true"
|
|
118
|
+
* }
|
|
119
|
+
* ]
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @example Update single boolean setting
|
|
125
|
+
* ```javascript
|
|
126
|
+
* //
|
|
127
|
+
* const input = {
|
|
128
|
+
* networkId: "12345678",
|
|
129
|
+
* settings: {
|
|
130
|
+
* enableClientMetrics: false
|
|
131
|
+
* }
|
|
132
|
+
* };
|
|
133
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
134
|
+
* const response = await client.send(command);
|
|
135
|
+
* /* response is
|
|
136
|
+
* {
|
|
137
|
+
* settings: [
|
|
138
|
+
* {
|
|
139
|
+
* optionName: "enableClientMetrics",
|
|
140
|
+
* type: "boolean",
|
|
141
|
+
* value: "false"
|
|
142
|
+
* }
|
|
143
|
+
* ]
|
|
144
|
+
* }
|
|
145
|
+
* *\/
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
148
|
+
* @example Update client metrics settings
|
|
149
|
+
* ```javascript
|
|
150
|
+
* //
|
|
151
|
+
* const input = {
|
|
152
|
+
* networkId: "12345678",
|
|
153
|
+
* settings: {
|
|
154
|
+
* enableClientMetrics: true
|
|
155
|
+
* }
|
|
156
|
+
* };
|
|
157
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
158
|
+
* const response = await client.send(command);
|
|
159
|
+
* /* response is
|
|
160
|
+
* {
|
|
161
|
+
* settings: [
|
|
162
|
+
* {
|
|
163
|
+
* optionName: "enableClientMetrics",
|
|
164
|
+
* type: "boolean",
|
|
165
|
+
* value: "true"
|
|
166
|
+
* }
|
|
167
|
+
* ]
|
|
168
|
+
* }
|
|
169
|
+
* *\/
|
|
170
|
+
* ```
|
|
171
|
+
*
|
|
172
|
+
* @example Invalid setting name error
|
|
173
|
+
* ```javascript
|
|
174
|
+
* //
|
|
175
|
+
* const input = {
|
|
176
|
+
* networkId: "12345678",
|
|
177
|
+
* settings: {
|
|
178
|
+
* enableClientMetrics: false
|
|
179
|
+
* }
|
|
180
|
+
* };
|
|
181
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
182
|
+
* const response = await client.send(command);
|
|
183
|
+
* /* response is
|
|
184
|
+
* { /* metadata only *\/ }
|
|
185
|
+
* *\/
|
|
186
|
+
* ```
|
|
187
|
+
*
|
|
188
|
+
* @example Network not found error
|
|
189
|
+
* ```javascript
|
|
190
|
+
* //
|
|
191
|
+
* const input = {
|
|
192
|
+
* networkId: "99999999",
|
|
193
|
+
* settings: {
|
|
194
|
+
* enableClientMetrics: true
|
|
195
|
+
* }
|
|
196
|
+
* };
|
|
197
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
198
|
+
* const response = await client.send(command);
|
|
199
|
+
* /* response is
|
|
200
|
+
* { /* metadata only *\/ }
|
|
201
|
+
* *\/
|
|
202
|
+
* ```
|
|
203
|
+
*
|
|
204
|
+
* @example Invalid value type error
|
|
205
|
+
* ```javascript
|
|
206
|
+
* //
|
|
207
|
+
* const input = {
|
|
208
|
+
* networkId: "12345678",
|
|
209
|
+
* settings: {
|
|
210
|
+
* dataRetention: true
|
|
211
|
+
* }
|
|
212
|
+
* };
|
|
213
|
+
* const command = new UpdateNetworkSettingsCommand(input);
|
|
214
|
+
* const response = await client.send(command);
|
|
215
|
+
* /* response is
|
|
216
|
+
* { /* metadata only *\/ }
|
|
217
|
+
* *\/
|
|
218
|
+
* ```
|
|
219
|
+
*
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
export declare class UpdateNetworkSettingsCommand extends UpdateNetworkSettingsCommand_base {
|
|
223
|
+
/** @internal type navigation helper, not in runtime. */
|
|
224
|
+
protected static __types: {
|
|
225
|
+
api: {
|
|
226
|
+
input: UpdateNetworkSettingsRequest;
|
|
227
|
+
output: UpdateNetworkSettingsResponse;
|
|
228
|
+
};
|
|
229
|
+
sdk: {
|
|
230
|
+
input: UpdateNetworkSettingsCommandInput;
|
|
231
|
+
output: UpdateNetworkSettingsCommandOutput;
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
}
|
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateSecurityGroupRequest, UpdateSecurityGroupResponse } 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 UpdateSecurityGroupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateSecurityGroupCommandInput extends UpdateSecurityGroupRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateSecurityGroupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateSecurityGroupCommandOutput extends UpdateSecurityGroupResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateSecurityGroupCommand_base: {
|
|
25
|
+
new (input: UpdateSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecurityGroupCommandInput, UpdateSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecurityGroupCommandInput, UpdateSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the properties of an existing security group in a Wickr network, such as its name or 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, UpdateSecurityGroupCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateSecurityGroupCommand } = 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 = { // UpdateSecurityGroupRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* groupId: "STRING_VALUE", // required
|
|
42
|
+
* name: "STRING_VALUE",
|
|
43
|
+
* securityGroupSettings: { // SecurityGroupSettings
|
|
44
|
+
* alwaysReauthenticate: true || false,
|
|
45
|
+
* atakPackageValues: [ // SecurityGroupStringList
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* calling: { // CallingSettings
|
|
49
|
+
* canStart11Call: true || false,
|
|
50
|
+
* canVideoCall: true || false,
|
|
51
|
+
* forceTcpCall: true || false,
|
|
52
|
+
* },
|
|
53
|
+
* checkForUpdates: true || false,
|
|
54
|
+
* enableAtak: true || false,
|
|
55
|
+
* enableCrashReports: true || false,
|
|
56
|
+
* enableFileDownload: true || false,
|
|
57
|
+
* enableGuestFederation: true || false,
|
|
58
|
+
* enableNotificationPreview: true || false,
|
|
59
|
+
* enableOpenAccessOption: true || false,
|
|
60
|
+
* enableRestrictedGlobalFederation: true || false,
|
|
61
|
+
* filesEnabled: true || false,
|
|
62
|
+
* forceDeviceLockout: Number("int"),
|
|
63
|
+
* forceOpenAccess: true || false,
|
|
64
|
+
* forceReadReceipts: true || false,
|
|
65
|
+
* globalFederation: true || false,
|
|
66
|
+
* isAtoEnabled: true || false,
|
|
67
|
+
* isLinkPreviewEnabled: true || false,
|
|
68
|
+
* locationAllowMaps: true || false,
|
|
69
|
+
* locationEnabled: true || false,
|
|
70
|
+
* maxAutoDownloadSize: Number("long"),
|
|
71
|
+
* maxBor: Number("int"),
|
|
72
|
+
* maxTtl: Number("long"),
|
|
73
|
+
* messageForwardingEnabled: true || false,
|
|
74
|
+
* passwordRequirements: { // PasswordRequirements
|
|
75
|
+
* lowercase: Number("int"),
|
|
76
|
+
* minLength: Number("int"),
|
|
77
|
+
* numbers: Number("int"),
|
|
78
|
+
* symbols: Number("int"),
|
|
79
|
+
* uppercase: Number("int"),
|
|
80
|
+
* },
|
|
81
|
+
* presenceEnabled: true || false,
|
|
82
|
+
* quickResponses: [
|
|
83
|
+
* "STRING_VALUE",
|
|
84
|
+
* ],
|
|
85
|
+
* showMasterRecoveryKey: true || false,
|
|
86
|
+
* shredder: { // ShredderSettings
|
|
87
|
+
* canProcessManually: true || false,
|
|
88
|
+
* intensity: Number("int"),
|
|
89
|
+
* },
|
|
90
|
+
* ssoMaxIdleMinutes: Number("int"),
|
|
91
|
+
* federationMode: Number("int"),
|
|
92
|
+
* lockoutThreshold: Number("int"),
|
|
93
|
+
* permittedNetworks: [ // PermittedNetworksList
|
|
94
|
+
* "STRING_VALUE",
|
|
95
|
+
* ],
|
|
96
|
+
* permittedWickrAwsNetworks: [ // WickrAwsNetworksList
|
|
97
|
+
* { // WickrAwsNetworks
|
|
98
|
+
* region: "STRING_VALUE", // required
|
|
99
|
+
* networkId: "STRING_VALUE", // required
|
|
100
|
+
* },
|
|
101
|
+
* ],
|
|
102
|
+
* permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
|
|
103
|
+
* { // PermittedWickrEnterpriseNetwork
|
|
104
|
+
* domain: "STRING_VALUE", // required
|
|
105
|
+
* networkId: "STRING_VALUE", // required
|
|
106
|
+
* },
|
|
107
|
+
* ],
|
|
108
|
+
* },
|
|
109
|
+
* };
|
|
110
|
+
* const command = new UpdateSecurityGroupCommand(input);
|
|
111
|
+
* const response = await client.send(command);
|
|
112
|
+
* // { // UpdateSecurityGroupResponse
|
|
113
|
+
* // securityGroup: { // SecurityGroup
|
|
114
|
+
* // activeMembers: Number("int"), // required
|
|
115
|
+
* // botMembers: Number("int"), // required
|
|
116
|
+
* // activeDirectoryGuid: "STRING_VALUE",
|
|
117
|
+
* // id: "STRING_VALUE", // required
|
|
118
|
+
* // isDefault: true || false, // required
|
|
119
|
+
* // name: "STRING_VALUE", // required
|
|
120
|
+
* // modified: Number("int"), // required
|
|
121
|
+
* // securityGroupSettings: { // SecurityGroupSettings
|
|
122
|
+
* // alwaysReauthenticate: true || false,
|
|
123
|
+
* // atakPackageValues: [ // SecurityGroupStringList
|
|
124
|
+
* // "STRING_VALUE",
|
|
125
|
+
* // ],
|
|
126
|
+
* // calling: { // CallingSettings
|
|
127
|
+
* // canStart11Call: true || false,
|
|
128
|
+
* // canVideoCall: true || false,
|
|
129
|
+
* // forceTcpCall: true || false,
|
|
130
|
+
* // },
|
|
131
|
+
* // checkForUpdates: true || false,
|
|
132
|
+
* // enableAtak: true || false,
|
|
133
|
+
* // enableCrashReports: true || false,
|
|
134
|
+
* // enableFileDownload: true || false,
|
|
135
|
+
* // enableGuestFederation: true || false,
|
|
136
|
+
* // enableNotificationPreview: true || false,
|
|
137
|
+
* // enableOpenAccessOption: true || false,
|
|
138
|
+
* // enableRestrictedGlobalFederation: true || false,
|
|
139
|
+
* // filesEnabled: true || false,
|
|
140
|
+
* // forceDeviceLockout: Number("int"),
|
|
141
|
+
* // forceOpenAccess: true || false,
|
|
142
|
+
* // forceReadReceipts: true || false,
|
|
143
|
+
* // globalFederation: true || false,
|
|
144
|
+
* // isAtoEnabled: true || false,
|
|
145
|
+
* // isLinkPreviewEnabled: true || false,
|
|
146
|
+
* // locationAllowMaps: true || false,
|
|
147
|
+
* // locationEnabled: true || false,
|
|
148
|
+
* // maxAutoDownloadSize: Number("long"),
|
|
149
|
+
* // maxBor: Number("int"),
|
|
150
|
+
* // maxTtl: Number("long"),
|
|
151
|
+
* // messageForwardingEnabled: true || false,
|
|
152
|
+
* // passwordRequirements: { // PasswordRequirements
|
|
153
|
+
* // lowercase: Number("int"),
|
|
154
|
+
* // minLength: Number("int"),
|
|
155
|
+
* // numbers: Number("int"),
|
|
156
|
+
* // symbols: Number("int"),
|
|
157
|
+
* // uppercase: Number("int"),
|
|
158
|
+
* // },
|
|
159
|
+
* // presenceEnabled: true || false,
|
|
160
|
+
* // quickResponses: [
|
|
161
|
+
* // "STRING_VALUE",
|
|
162
|
+
* // ],
|
|
163
|
+
* // showMasterRecoveryKey: true || false,
|
|
164
|
+
* // shredder: { // ShredderSettings
|
|
165
|
+
* // canProcessManually: true || false,
|
|
166
|
+
* // intensity: Number("int"),
|
|
167
|
+
* // },
|
|
168
|
+
* // ssoMaxIdleMinutes: Number("int"),
|
|
169
|
+
* // federationMode: Number("int"),
|
|
170
|
+
* // lockoutThreshold: Number("int"),
|
|
171
|
+
* // permittedNetworks: [ // PermittedNetworksList
|
|
172
|
+
* // "STRING_VALUE",
|
|
173
|
+
* // ],
|
|
174
|
+
* // permittedWickrAwsNetworks: [ // WickrAwsNetworksList
|
|
175
|
+
* // { // WickrAwsNetworks
|
|
176
|
+
* // region: "STRING_VALUE", // required
|
|
177
|
+
* // networkId: "STRING_VALUE", // required
|
|
178
|
+
* // },
|
|
179
|
+
* // ],
|
|
180
|
+
* // permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
|
|
181
|
+
* // { // PermittedWickrEnterpriseNetwork
|
|
182
|
+
* // domain: "STRING_VALUE", // required
|
|
183
|
+
* // networkId: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // ],
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // };
|
|
189
|
+
*
|
|
190
|
+
* ```
|
|
191
|
+
*
|
|
192
|
+
* @param UpdateSecurityGroupCommandInput - {@link UpdateSecurityGroupCommandInput}
|
|
193
|
+
* @returns {@link UpdateSecurityGroupCommandOutput}
|
|
194
|
+
* @see {@link UpdateSecurityGroupCommandInput} for command's `input` shape.
|
|
195
|
+
* @see {@link UpdateSecurityGroupCommandOutput} for command's `response` shape.
|
|
196
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
197
|
+
*
|
|
198
|
+
* @throws {@link BadRequestError} (client fault)
|
|
199
|
+
* <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>
|
|
200
|
+
*
|
|
201
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
202
|
+
* <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>
|
|
203
|
+
*
|
|
204
|
+
* @throws {@link InternalServerError} (server fault)
|
|
205
|
+
* <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>
|
|
206
|
+
*
|
|
207
|
+
* @throws {@link RateLimitError} (client fault)
|
|
208
|
+
* <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>
|
|
209
|
+
*
|
|
210
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
211
|
+
* <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>
|
|
212
|
+
*
|
|
213
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
214
|
+
* <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>
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link ValidationError} (client fault)
|
|
217
|
+
* <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>
|
|
218
|
+
*
|
|
219
|
+
* @throws {@link WickrServiceException}
|
|
220
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
221
|
+
*
|
|
222
|
+
*
|
|
223
|
+
* @example Update security group successfully
|
|
224
|
+
* ```javascript
|
|
225
|
+
* //
|
|
226
|
+
* const input = {
|
|
227
|
+
* groupId: "abc12345",
|
|
228
|
+
* name: "Updated Group Name",
|
|
229
|
+
* networkId: "12345678",
|
|
230
|
+
* securityGroupSettings: {
|
|
231
|
+
* lockoutThreshold: 15
|
|
232
|
+
* }
|
|
233
|
+
* };
|
|
234
|
+
* const command = new UpdateSecurityGroupCommand(input);
|
|
235
|
+
* const response = await client.send(command);
|
|
236
|
+
* /* response is
|
|
237
|
+
* {
|
|
238
|
+
* securityGroup: {
|
|
239
|
+
* activeMembers: 10,
|
|
240
|
+
* botMembers: 2,
|
|
241
|
+
* id: "abc12345",
|
|
242
|
+
* isDefault: false,
|
|
243
|
+
* modified: 1638360000,
|
|
244
|
+
* name: "Updated Group Name",
|
|
245
|
+
* securityGroupSettings: {
|
|
246
|
+
* lockoutThreshold: 15
|
|
247
|
+
* }
|
|
248
|
+
* }
|
|
249
|
+
* }
|
|
250
|
+
* *\/
|
|
251
|
+
* ```
|
|
252
|
+
*
|
|
253
|
+
* @example Update security group - not found
|
|
254
|
+
* ```javascript
|
|
255
|
+
* //
|
|
256
|
+
* const input = {
|
|
257
|
+
* groupId: "invalid99",
|
|
258
|
+
* name: "New Name",
|
|
259
|
+
* networkId: "12345678"
|
|
260
|
+
* };
|
|
261
|
+
* const command = new UpdateSecurityGroupCommand(input);
|
|
262
|
+
* const response = await client.send(command);
|
|
263
|
+
* /* response is
|
|
264
|
+
* { /* metadata only *\/ }
|
|
265
|
+
* *\/
|
|
266
|
+
* ```
|
|
267
|
+
*
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export declare class UpdateSecurityGroupCommand extends UpdateSecurityGroupCommand_base {
|
|
271
|
+
/** @internal type navigation helper, not in runtime. */
|
|
272
|
+
protected static __types: {
|
|
273
|
+
api: {
|
|
274
|
+
input: UpdateSecurityGroupRequest;
|
|
275
|
+
output: UpdateSecurityGroupResponse;
|
|
276
|
+
};
|
|
277
|
+
sdk: {
|
|
278
|
+
input: UpdateSecurityGroupCommandInput;
|
|
279
|
+
output: UpdateSecurityGroupCommandOutput;
|
|
280
|
+
};
|
|
281
|
+
};
|
|
282
|
+
}
|