@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,130 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DeleteSecurityGroupRequest, DeleteSecurityGroupResponse } 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 DeleteSecurityGroupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteSecurityGroupCommandInput extends DeleteSecurityGroupRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteSecurityGroupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteSecurityGroupCommandOutput extends DeleteSecurityGroupResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteSecurityGroupCommand_base: {
|
|
25
|
+
new (input: DeleteSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSecurityGroupCommandInput, DeleteSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSecurityGroupCommandInput, DeleteSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, DeleteSecurityGroupCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, DeleteSecurityGroupCommand } = 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 = { // DeleteSecurityGroupRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* groupId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteSecurityGroupCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DeleteSecurityGroupResponse
|
|
46
|
+
* // message: "STRING_VALUE",
|
|
47
|
+
* // networkId: "STRING_VALUE",
|
|
48
|
+
* // groupId: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param DeleteSecurityGroupCommandInput - {@link DeleteSecurityGroupCommandInput}
|
|
54
|
+
* @returns {@link DeleteSecurityGroupCommandOutput}
|
|
55
|
+
* @see {@link DeleteSecurityGroupCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link DeleteSecurityGroupCommandOutput} 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 Delete security group successfully
|
|
85
|
+
* ```javascript
|
|
86
|
+
* //
|
|
87
|
+
* const input = {
|
|
88
|
+
* groupId: "def67890",
|
|
89
|
+
* networkId: "12345678"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new DeleteSecurityGroupCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* groupId: "def67890",
|
|
96
|
+
* message: "success",
|
|
97
|
+
* networkId: "12345678"
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
102
|
+
* @example Delete security group - not found
|
|
103
|
+
* ```javascript
|
|
104
|
+
* //
|
|
105
|
+
* const input = {
|
|
106
|
+
* groupId: "invalid99",
|
|
107
|
+
* networkId: "12345678"
|
|
108
|
+
* };
|
|
109
|
+
* const command = new DeleteSecurityGroupCommand(input);
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response is
|
|
112
|
+
* { /* metadata only *\/ }
|
|
113
|
+
* *\/
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export declare class DeleteSecurityGroupCommand extends DeleteSecurityGroupCommand_base {
|
|
119
|
+
/** @internal type navigation helper, not in runtime. */
|
|
120
|
+
protected static __types: {
|
|
121
|
+
api: {
|
|
122
|
+
input: DeleteSecurityGroupRequest;
|
|
123
|
+
output: DeleteSecurityGroupResponse;
|
|
124
|
+
};
|
|
125
|
+
sdk: {
|
|
126
|
+
input: DeleteSecurityGroupCommandInput;
|
|
127
|
+
output: DeleteSecurityGroupCommandOutput;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetBotRequest, GetBotResponse } 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 GetBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetBotCommandInput extends GetBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetBotCommandOutput extends GetBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetBotCommand_base: {
|
|
25
|
+
new (input: GetBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCommandInput, GetBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCommandInput, GetBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetBotCommand } = 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 = { // GetBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* botId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetBotCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetBotResponse
|
|
46
|
+
* // botId: "STRING_VALUE",
|
|
47
|
+
* // displayName: "STRING_VALUE",
|
|
48
|
+
* // username: "STRING_VALUE",
|
|
49
|
+
* // uname: "STRING_VALUE",
|
|
50
|
+
* // pubkey: "STRING_VALUE",
|
|
51
|
+
* // status: 1 || 2,
|
|
52
|
+
* // groupId: "STRING_VALUE",
|
|
53
|
+
* // hasChallenge: true || false,
|
|
54
|
+
* // suspended: true || false,
|
|
55
|
+
* // lastLogin: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param GetBotCommandInput - {@link GetBotCommandInput}
|
|
61
|
+
* @returns {@link GetBotCommandOutput}
|
|
62
|
+
* @see {@link GetBotCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link GetBotCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link BadRequestError} (client fault)
|
|
67
|
+
* <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>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
70
|
+
* <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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerError} (server fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link RateLimitError} (client fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationError} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link WickrServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @example Get bot successfully
|
|
92
|
+
* ```javascript
|
|
93
|
+
* //
|
|
94
|
+
* const input = {
|
|
95
|
+
* botId: "98765",
|
|
96
|
+
* networkId: "12345678"
|
|
97
|
+
* };
|
|
98
|
+
* const command = new GetBotCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response is
|
|
101
|
+
* {
|
|
102
|
+
* botId: "98765",
|
|
103
|
+
* displayName: "Support Bot",
|
|
104
|
+
* groupId: "default_group",
|
|
105
|
+
* hasChallenge: true,
|
|
106
|
+
* lastLogin: "1704067200",
|
|
107
|
+
* pubkey: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF4",
|
|
108
|
+
* status: 2,
|
|
109
|
+
* suspended: false,
|
|
110
|
+
* uname: "abc123def456",
|
|
111
|
+
* username: "support_bot"
|
|
112
|
+
* }
|
|
113
|
+
* *\/
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
116
|
+
* @example Get bot - bot not found
|
|
117
|
+
* ```javascript
|
|
118
|
+
* //
|
|
119
|
+
* const input = {
|
|
120
|
+
* botId: "99999",
|
|
121
|
+
* networkId: "12345678"
|
|
122
|
+
* };
|
|
123
|
+
* const command = new GetBotCommand(input);
|
|
124
|
+
* const response = await client.send(command);
|
|
125
|
+
* /* response is
|
|
126
|
+
* { /* metadata only *\/ }
|
|
127
|
+
* *\/
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class GetBotCommand extends GetBotCommand_base {
|
|
133
|
+
/** @internal type navigation helper, not in runtime. */
|
|
134
|
+
protected static __types: {
|
|
135
|
+
api: {
|
|
136
|
+
input: GetBotRequest;
|
|
137
|
+
output: GetBotResponse;
|
|
138
|
+
};
|
|
139
|
+
sdk: {
|
|
140
|
+
input: GetBotCommandInput;
|
|
141
|
+
output: GetBotCommandOutput;
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetBotsCountRequest, GetBotsCountResponse } 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 GetBotsCountCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetBotsCountCommandInput extends GetBotsCountRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetBotsCountCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetBotsCountCommandOutput extends GetBotsCountResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetBotsCountCommand_base: {
|
|
25
|
+
new (input: GetBotsCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotsCountCommandInput, GetBotsCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetBotsCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotsCountCommandInput, GetBotsCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetBotsCountCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetBotsCountCommand } = 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 = { // GetBotsCountRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetBotsCountCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetBotsCountResponse
|
|
45
|
+
* // pending: Number("int"), // required
|
|
46
|
+
* // active: Number("int"), // required
|
|
47
|
+
* // total: Number("int"), // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param GetBotsCountCommandInput - {@link GetBotsCountCommandInput}
|
|
53
|
+
* @returns {@link GetBotsCountCommandOutput}
|
|
54
|
+
* @see {@link GetBotsCountCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link GetBotsCountCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestError} (client fault)
|
|
59
|
+
* <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>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
62
|
+
* <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>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServerError} (server fault)
|
|
65
|
+
* <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>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link RateLimitError} (client fault)
|
|
68
|
+
* <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>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
71
|
+
* <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>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
74
|
+
* <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>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationError} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link WickrServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @example Get bots count successfully
|
|
84
|
+
* ```javascript
|
|
85
|
+
* //
|
|
86
|
+
* const input = {
|
|
87
|
+
* networkId: "12345678"
|
|
88
|
+
* };
|
|
89
|
+
* const command = new GetBotsCountCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* {
|
|
93
|
+
* active: 12,
|
|
94
|
+
* pending: 2,
|
|
95
|
+
* total: 15
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* @example Get bots count with filters
|
|
101
|
+
* ```javascript
|
|
102
|
+
* //
|
|
103
|
+
* const input = {
|
|
104
|
+
* networkId: "12345678"
|
|
105
|
+
* };
|
|
106
|
+
* const command = new GetBotsCountCommand(input);
|
|
107
|
+
* const response = await client.send(command);
|
|
108
|
+
* /* response is
|
|
109
|
+
* {
|
|
110
|
+
* active: 12,
|
|
111
|
+
* pending: 0,
|
|
112
|
+
* total: 12
|
|
113
|
+
* }
|
|
114
|
+
* *\/
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class GetBotsCountCommand extends GetBotsCountCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: GetBotsCountRequest;
|
|
124
|
+
output: GetBotsCountResponse;
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: GetBotsCountCommandInput;
|
|
128
|
+
output: GetBotsCountCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetDataRetentionBotRequest, GetDataRetentionBotResponse } 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 GetDataRetentionBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDataRetentionBotCommandInput extends GetDataRetentionBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDataRetentionBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDataRetentionBotCommandOutput extends GetDataRetentionBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDataRetentionBotCommand_base: {
|
|
25
|
+
new (input: GetDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataRetentionBotCommandInput, GetDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetDataRetentionBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataRetentionBotCommandInput, GetDataRetentionBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetDataRetentionBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetDataRetentionBotCommand } = 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 = { // GetDataRetentionBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetDataRetentionBotCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetDataRetentionBotResponse
|
|
45
|
+
* // botName: "STRING_VALUE",
|
|
46
|
+
* // botExists: true || false,
|
|
47
|
+
* // isBotActive: true || false,
|
|
48
|
+
* // isDataRetentionBotRegistered: true || false,
|
|
49
|
+
* // isDataRetentionServiceEnabled: true || false,
|
|
50
|
+
* // isPubkeyMsgAcked: true || false,
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetDataRetentionBotCommandInput - {@link GetDataRetentionBotCommandInput}
|
|
56
|
+
* @returns {@link GetDataRetentionBotCommandOutput}
|
|
57
|
+
* @see {@link GetDataRetentionBotCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetDataRetentionBotCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link BadRequestError} (client fault)
|
|
62
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
65
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerError} (server fault)
|
|
68
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link RateLimitError} (client fault)
|
|
71
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
74
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
77
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationError} (client fault)
|
|
80
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link WickrServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @example Get data retention bot successfully
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* networkId: "12345678"
|
|
91
|
+
* };
|
|
92
|
+
* const command = new GetDataRetentionBotCommand(input);
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* {
|
|
96
|
+
* botExists: true,
|
|
97
|
+
* botName: "compliance_12345678_bot",
|
|
98
|
+
* isBotActive: true,
|
|
99
|
+
* isDataRetentionBotRegistered: true,
|
|
100
|
+
* isDataRetentionServiceEnabled: true,
|
|
101
|
+
* isPubkeyMsgAcked: false
|
|
102
|
+
* }
|
|
103
|
+
* *\/
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @example Get data retention bot - not provisioned
|
|
107
|
+
* ```javascript
|
|
108
|
+
* //
|
|
109
|
+
* const input = {
|
|
110
|
+
* networkId: "12345678"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new GetDataRetentionBotCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* botExists: false,
|
|
117
|
+
* botName: "compliance_12345678_bot",
|
|
118
|
+
* isBotActive: false,
|
|
119
|
+
* isDataRetentionBotRegistered: false,
|
|
120
|
+
* isDataRetentionServiceEnabled: false,
|
|
121
|
+
* isPubkeyMsgAcked: false
|
|
122
|
+
* }
|
|
123
|
+
* *\/
|
|
124
|
+
* ```
|
|
125
|
+
*
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export declare class GetDataRetentionBotCommand extends GetDataRetentionBotCommand_base {
|
|
129
|
+
/** @internal type navigation helper, not in runtime. */
|
|
130
|
+
protected static __types: {
|
|
131
|
+
api: {
|
|
132
|
+
input: GetDataRetentionBotRequest;
|
|
133
|
+
output: GetDataRetentionBotResponse;
|
|
134
|
+
};
|
|
135
|
+
sdk: {
|
|
136
|
+
input: GetDataRetentionBotCommandInput;
|
|
137
|
+
output: GetDataRetentionBotCommandOutput;
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
}
|