@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,168 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { RegisterOidcConfigTestRequest, RegisterOidcConfigTestResponse } 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 RegisterOidcConfigTestCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RegisterOidcConfigTestCommandInput extends RegisterOidcConfigTestRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RegisterOidcConfigTestCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RegisterOidcConfigTestCommandOutput extends RegisterOidcConfigTestResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RegisterOidcConfigTestCommand_base: {
|
|
25
|
+
new (input: RegisterOidcConfigTestCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterOidcConfigTestCommandInput, RegisterOidcConfigTestCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: RegisterOidcConfigTestCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterOidcConfigTestCommandInput, RegisterOidcConfigTestCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, RegisterOidcConfigTestCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, RegisterOidcConfigTestCommand } = 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 = { // RegisterOidcConfigTestRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* extraAuthParams: "STRING_VALUE",
|
|
42
|
+
* issuer: "STRING_VALUE", // required
|
|
43
|
+
* scopes: "STRING_VALUE", // required
|
|
44
|
+
* certificate: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new RegisterOidcConfigTestCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // RegisterOidcConfigTestResponse
|
|
49
|
+
* // tokenEndpoint: "STRING_VALUE",
|
|
50
|
+
* // userinfoEndpoint: "STRING_VALUE",
|
|
51
|
+
* // responseTypesSupported: [ // StringList
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // scopesSupported: [
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // issuer: "STRING_VALUE",
|
|
58
|
+
* // authorizationEndpoint: "STRING_VALUE",
|
|
59
|
+
* // endSessionEndpoint: "STRING_VALUE",
|
|
60
|
+
* // logoutEndpoint: "STRING_VALUE",
|
|
61
|
+
* // grantTypesSupported: [
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // revocationEndpoint: "STRING_VALUE",
|
|
65
|
+
* // tokenEndpointAuthMethodsSupported: [
|
|
66
|
+
* // "STRING_VALUE",
|
|
67
|
+
* // ],
|
|
68
|
+
* // microsoftMultiRefreshToken: true || false,
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param RegisterOidcConfigTestCommandInput - {@link RegisterOidcConfigTestCommandInput}
|
|
74
|
+
* @returns {@link RegisterOidcConfigTestCommandOutput}
|
|
75
|
+
* @see {@link RegisterOidcConfigTestCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link RegisterOidcConfigTestCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link BadRequestError} (client fault)
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerError} (server fault)
|
|
86
|
+
* <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>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link RateLimitError} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
92
|
+
* <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>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
95
|
+
* <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>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ValidationError} (client fault)
|
|
98
|
+
* <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>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link WickrServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
102
|
+
*
|
|
103
|
+
*
|
|
104
|
+
* @example Test OIDC config successfully
|
|
105
|
+
* ```javascript
|
|
106
|
+
* //
|
|
107
|
+
* const input = {
|
|
108
|
+
* issuer: "https://login.example.com",
|
|
109
|
+
* networkId: "12345678",
|
|
110
|
+
* scopes: "openid profile email"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new RegisterOidcConfigTestCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* authorizationEndpoint: "https://login.example.com/authorize",
|
|
117
|
+
* issuer: "https://login.example.com",
|
|
118
|
+
* tokenEndpoint: "https://login.example.com/oauth/token",
|
|
119
|
+
* userinfoEndpoint: "https://login.example.com/userinfo"
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* @example Test OIDC config - missing issuer
|
|
125
|
+
* ```javascript
|
|
126
|
+
* //
|
|
127
|
+
* const input = {
|
|
128
|
+
* issuer: "",
|
|
129
|
+
* networkId: "12345678",
|
|
130
|
+
* scopes: "openid profile email"
|
|
131
|
+
* };
|
|
132
|
+
* const command = new RegisterOidcConfigTestCommand(input);
|
|
133
|
+
* const response = await client.send(command);
|
|
134
|
+
* /* response is
|
|
135
|
+
* { /* metadata only *\/ }
|
|
136
|
+
* *\/
|
|
137
|
+
* ```
|
|
138
|
+
*
|
|
139
|
+
* @example Test OIDC config - invalid endpoint
|
|
140
|
+
* ```javascript
|
|
141
|
+
* //
|
|
142
|
+
* const input = {
|
|
143
|
+
* issuer: "https://blocked-endpoint.com",
|
|
144
|
+
* networkId: "12345678",
|
|
145
|
+
* scopes: "openid profile email"
|
|
146
|
+
* };
|
|
147
|
+
* const command = new RegisterOidcConfigTestCommand(input);
|
|
148
|
+
* const response = await client.send(command);
|
|
149
|
+
* /* response is
|
|
150
|
+
* { /* metadata only *\/ }
|
|
151
|
+
* *\/
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export declare class RegisterOidcConfigTestCommand extends RegisterOidcConfigTestCommand_base {
|
|
157
|
+
/** @internal type navigation helper, not in runtime. */
|
|
158
|
+
protected static __types: {
|
|
159
|
+
api: {
|
|
160
|
+
input: RegisterOidcConfigTestRequest;
|
|
161
|
+
output: RegisterOidcConfigTestResponse;
|
|
162
|
+
};
|
|
163
|
+
sdk: {
|
|
164
|
+
input: RegisterOidcConfigTestCommandInput;
|
|
165
|
+
output: RegisterOidcConfigTestCommandOutput;
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateBotRequest, UpdateBotResponse } 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 UpdateBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateBotCommandInput extends UpdateBotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateBotCommandOutput extends UpdateBotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateBotCommand_base: {
|
|
25
|
+
new (input: UpdateBotCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCommandInput, UpdateBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateBotCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCommandInput, UpdateBotCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, UpdateBotCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateBotCommand } = 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 = { // UpdateBotRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* botId: "STRING_VALUE", // required
|
|
42
|
+
* displayName: "STRING_VALUE",
|
|
43
|
+
* groupId: "STRING_VALUE",
|
|
44
|
+
* challenge: "STRING_VALUE",
|
|
45
|
+
* suspend: true || false,
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateBotCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // UpdateBotResponse
|
|
50
|
+
* // message: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param UpdateBotCommandInput - {@link UpdateBotCommandInput}
|
|
56
|
+
* @returns {@link UpdateBotCommandOutput}
|
|
57
|
+
* @see {@link UpdateBotCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link UpdateBotCommandOutput} 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 Update bot successfully
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* botId: "98765",
|
|
91
|
+
* displayName: "Updated Support Bot",
|
|
92
|
+
* groupId: "support_group",
|
|
93
|
+
* networkId: "12345678"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new UpdateBotCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response is
|
|
98
|
+
* {
|
|
99
|
+
* message: "success"
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* @example Update bot - bot not found
|
|
105
|
+
* ```javascript
|
|
106
|
+
* //
|
|
107
|
+
* const input = {
|
|
108
|
+
* botId: "99999",
|
|
109
|
+
* displayName: "Updated Bot",
|
|
110
|
+
* networkId: "12345678"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new UpdateBotCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* { /* metadata only *\/ }
|
|
116
|
+
* *\/
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export declare class UpdateBotCommand extends UpdateBotCommand_base {
|
|
122
|
+
/** @internal type navigation helper, not in runtime. */
|
|
123
|
+
protected static __types: {
|
|
124
|
+
api: {
|
|
125
|
+
input: UpdateBotRequest;
|
|
126
|
+
output: UpdateBotResponse;
|
|
127
|
+
};
|
|
128
|
+
sdk: {
|
|
129
|
+
input: UpdateBotCommandInput;
|
|
130
|
+
output: UpdateBotCommandOutput;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
}
|
|
@@ -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 { UpdateDataRetentionRequest, UpdateDataRetentionResponse } 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 UpdateDataRetentionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateDataRetentionCommandInput extends UpdateDataRetentionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateDataRetentionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateDataRetentionCommandOutput extends UpdateDataRetentionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateDataRetentionCommand_base: {
|
|
25
|
+
new (input: UpdateDataRetentionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDataRetentionCommandInput, UpdateDataRetentionCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateDataRetentionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDataRetentionCommandInput, UpdateDataRetentionCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, UpdateDataRetentionCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateDataRetentionCommand } = 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 = { // UpdateDataRetentionRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* actionType: "ENABLE" || "DISABLE" || "PUBKEY_MSG_ACK", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UpdateDataRetentionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // UpdateDataRetentionResponse
|
|
46
|
+
* // message: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param UpdateDataRetentionCommandInput - {@link UpdateDataRetentionCommandInput}
|
|
52
|
+
* @returns {@link UpdateDataRetentionCommandOutput}
|
|
53
|
+
* @see {@link UpdateDataRetentionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link UpdateDataRetentionCommandOutput} 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 Update data retention - enable service
|
|
83
|
+
* ```javascript
|
|
84
|
+
* //
|
|
85
|
+
* const input = {
|
|
86
|
+
* actionType: "ENABLE",
|
|
87
|
+
* networkId: "12345678"
|
|
88
|
+
* };
|
|
89
|
+
* const command = new UpdateDataRetentionCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* {
|
|
93
|
+
* message: "data retention service enabled"
|
|
94
|
+
* }
|
|
95
|
+
* *\/
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @example Update data retention - disable service
|
|
99
|
+
* ```javascript
|
|
100
|
+
* //
|
|
101
|
+
* const input = {
|
|
102
|
+
* actionType: "DISABLE",
|
|
103
|
+
* networkId: "12345678"
|
|
104
|
+
* };
|
|
105
|
+
* const command = new UpdateDataRetentionCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response is
|
|
108
|
+
* {
|
|
109
|
+
* message: "data retention service disabled"
|
|
110
|
+
* }
|
|
111
|
+
* *\/
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* @example Update data retention - acknowledge pubkey message
|
|
115
|
+
* ```javascript
|
|
116
|
+
* //
|
|
117
|
+
* const input = {
|
|
118
|
+
* actionType: "PUBKEY_MSG_ACK",
|
|
119
|
+
* networkId: "12345678"
|
|
120
|
+
* };
|
|
121
|
+
* const command = new UpdateDataRetentionCommand(input);
|
|
122
|
+
* const response = await client.send(command);
|
|
123
|
+
* /* response is
|
|
124
|
+
* {
|
|
125
|
+
* message: "pubkey message was acknowledged"
|
|
126
|
+
* }
|
|
127
|
+
* *\/
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class UpdateDataRetentionCommand extends UpdateDataRetentionCommand_base {
|
|
133
|
+
/** @internal type navigation helper, not in runtime. */
|
|
134
|
+
protected static __types: {
|
|
135
|
+
api: {
|
|
136
|
+
input: UpdateDataRetentionRequest;
|
|
137
|
+
output: UpdateDataRetentionResponse;
|
|
138
|
+
};
|
|
139
|
+
sdk: {
|
|
140
|
+
input: UpdateDataRetentionCommandInput;
|
|
141
|
+
output: UpdateDataRetentionCommandOutput;
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { UpdateGuestUserRequest, UpdateGuestUserResponse } 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 UpdateGuestUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateGuestUserCommandInput extends UpdateGuestUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateGuestUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateGuestUserCommandOutput extends UpdateGuestUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateGuestUserCommand_base: {
|
|
25
|
+
new (input: UpdateGuestUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateGuestUserCommandInput, UpdateGuestUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateGuestUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateGuestUserCommandInput, UpdateGuestUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing 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, UpdateGuestUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, UpdateGuestUserCommand } = 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 = { // UpdateGuestUserRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* usernameHash: "STRING_VALUE", // required
|
|
42
|
+
* block: true || false, // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new UpdateGuestUserCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // UpdateGuestUserResponse
|
|
47
|
+
* // message: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param UpdateGuestUserCommandInput - {@link UpdateGuestUserCommandInput}
|
|
53
|
+
* @returns {@link UpdateGuestUserCommandOutput}
|
|
54
|
+
* @see {@link UpdateGuestUserCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link UpdateGuestUserCommandOutput} 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 Block a guest user
|
|
84
|
+
* ```javascript
|
|
85
|
+
* //
|
|
86
|
+
* const input = {
|
|
87
|
+
* block: true,
|
|
88
|
+
* networkId: "12345678",
|
|
89
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new UpdateGuestUserCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* message: "success"
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* @example Unblock a guest user
|
|
101
|
+
* ```javascript
|
|
102
|
+
* //
|
|
103
|
+
* const input = {
|
|
104
|
+
* block: false,
|
|
105
|
+
* networkId: "12345678",
|
|
106
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
107
|
+
* };
|
|
108
|
+
* const command = new UpdateGuestUserCommand(input);
|
|
109
|
+
* const response = await client.send(command);
|
|
110
|
+
* /* response is
|
|
111
|
+
* {
|
|
112
|
+
* message: "success"
|
|
113
|
+
* }
|
|
114
|
+
* *\/
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
117
|
+
* @example User already blocked error
|
|
118
|
+
* ```javascript
|
|
119
|
+
* //
|
|
120
|
+
* const input = {
|
|
121
|
+
* block: true,
|
|
122
|
+
* networkId: "12345678",
|
|
123
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
124
|
+
* };
|
|
125
|
+
* const command = new UpdateGuestUserCommand(input);
|
|
126
|
+
* const response = await client.send(command);
|
|
127
|
+
* /* response is
|
|
128
|
+
* { /* metadata only *\/ }
|
|
129
|
+
* *\/
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare class UpdateGuestUserCommand extends UpdateGuestUserCommand_base {
|
|
135
|
+
/** @internal type navigation helper, not in runtime. */
|
|
136
|
+
protected static __types: {
|
|
137
|
+
api: {
|
|
138
|
+
input: UpdateGuestUserRequest;
|
|
139
|
+
output: UpdateGuestUserResponse;
|
|
140
|
+
};
|
|
141
|
+
sdk: {
|
|
142
|
+
input: UpdateGuestUserCommandInput;
|
|
143
|
+
output: UpdateGuestUserCommandOutput;
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
}
|