@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,75 @@
|
|
|
1
|
+
import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
|
|
2
|
+
import type { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
|
|
3
|
+
import { type WickrClientResolvedConfig } from "../WickrClient";
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export interface WickrHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
|
|
8
|
+
region?: string;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export interface WickrHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<WickrClientResolvedConfig, HandlerExecutionContext, WickrHttpAuthSchemeParameters, object> {
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
export declare const defaultWickrHttpAuthSchemeParametersProvider: (config: WickrClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<WickrHttpAuthSchemeParameters>;
|
|
19
|
+
/**
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
22
|
+
export interface WickrHttpAuthSchemeProvider extends HttpAuthSchemeProvider<WickrHttpAuthSchemeParameters> {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
27
|
+
export declare const defaultWickrHttpAuthSchemeProvider: WickrHttpAuthSchemeProvider;
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
|
|
32
|
+
/**
|
|
33
|
+
* A comma-separated list of case-sensitive auth scheme names.
|
|
34
|
+
* An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
|
|
35
|
+
* For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
authSchemePreference?: string[] | Provider<string[]>;
|
|
39
|
+
/**
|
|
40
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
httpAuthSchemes?: HttpAuthScheme[];
|
|
44
|
+
/**
|
|
45
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
46
|
+
* @internal
|
|
47
|
+
*/
|
|
48
|
+
httpAuthSchemeProvider?: WickrHttpAuthSchemeProvider;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
|
|
54
|
+
/**
|
|
55
|
+
* A comma-separated list of case-sensitive auth scheme names.
|
|
56
|
+
* An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
|
|
57
|
+
* For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
readonly authSchemePreference: Provider<string[]>;
|
|
61
|
+
/**
|
|
62
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
readonly httpAuthSchemes: HttpAuthScheme[];
|
|
66
|
+
/**
|
|
67
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
70
|
+
readonly httpAuthSchemeProvider: WickrHttpAuthSchemeProvider;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
*/
|
|
75
|
+
export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
|
|
@@ -0,0 +1,251 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BatchCreateUserRequest, BatchCreateUserResponse } 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 BatchCreateUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchCreateUserCommandInput extends BatchCreateUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchCreateUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchCreateUserCommandOutput extends BatchCreateUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchCreateUserCommand_base: {
|
|
25
|
+
new (input: BatchCreateUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchCreateUserCommandInput, BatchCreateUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: BatchCreateUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchCreateUserCommandInput, BatchCreateUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user.</p> <note> <p> <code>codeValidation</code>, <code>inviteCode</code>, and <code>inviteCodeTtl</code> are restricted to networks under preview only.</p> </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, BatchCreateUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, BatchCreateUserCommand } = 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 = { // BatchCreateUserRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* users: [ // BatchCreateUserRequestItems // required
|
|
42
|
+
* { // BatchCreateUserRequestItem
|
|
43
|
+
* firstName: "STRING_VALUE",
|
|
44
|
+
* lastName: "STRING_VALUE",
|
|
45
|
+
* securityGroupIds: [ // SecurityGroupIdList // required
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* username: "STRING_VALUE", // required
|
|
49
|
+
* inviteCode: "STRING_VALUE",
|
|
50
|
+
* inviteCodeTtl: Number("int"),
|
|
51
|
+
* codeValidation: true || false,
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* clientToken: "STRING_VALUE",
|
|
55
|
+
* };
|
|
56
|
+
* const command = new BatchCreateUserCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* // { // BatchCreateUserResponse
|
|
59
|
+
* // message: "STRING_VALUE",
|
|
60
|
+
* // successful: [ // Users
|
|
61
|
+
* // { // User
|
|
62
|
+
* // userId: "STRING_VALUE",
|
|
63
|
+
* // firstName: "STRING_VALUE",
|
|
64
|
+
* // lastName: "STRING_VALUE",
|
|
65
|
+
* // username: "STRING_VALUE",
|
|
66
|
+
* // securityGroups: [ // SecurityGroupIdList
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // isAdmin: true || false,
|
|
70
|
+
* // suspended: true || false,
|
|
71
|
+
* // status: Number("int"),
|
|
72
|
+
* // otpEnabled: true || false,
|
|
73
|
+
* // scimId: "STRING_VALUE",
|
|
74
|
+
* // type: "STRING_VALUE",
|
|
75
|
+
* // cell: "STRING_VALUE",
|
|
76
|
+
* // countryCode: "STRING_VALUE",
|
|
77
|
+
* // challengeFailures: Number("int"),
|
|
78
|
+
* // isInviteExpired: true || false,
|
|
79
|
+
* // isUser: true || false,
|
|
80
|
+
* // inviteCode: "STRING_VALUE",
|
|
81
|
+
* // codeValidation: true || false,
|
|
82
|
+
* // uname: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // failed: [ // BatchUserErrorResponseItems
|
|
86
|
+
* // { // BatchUserErrorResponseItem
|
|
87
|
+
* // field: "STRING_VALUE",
|
|
88
|
+
* // reason: "STRING_VALUE",
|
|
89
|
+
* // userId: "STRING_VALUE", // required
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // };
|
|
93
|
+
*
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @param BatchCreateUserCommandInput - {@link BatchCreateUserCommandInput}
|
|
97
|
+
* @returns {@link BatchCreateUserCommandOutput}
|
|
98
|
+
* @see {@link BatchCreateUserCommandInput} for command's `input` shape.
|
|
99
|
+
* @see {@link BatchCreateUserCommandOutput} for command's `response` shape.
|
|
100
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link BadRequestError} (client fault)
|
|
103
|
+
* <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>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
106
|
+
* <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>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link InternalServerError} (server fault)
|
|
109
|
+
* <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>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link RateLimitError} (client fault)
|
|
112
|
+
* <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>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
115
|
+
* <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>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
118
|
+
* <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>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link ValidationError} (client fault)
|
|
121
|
+
* <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>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link WickrServiceException}
|
|
124
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
125
|
+
*
|
|
126
|
+
*
|
|
127
|
+
* @example Create multiple users
|
|
128
|
+
* ```javascript
|
|
129
|
+
* //
|
|
130
|
+
* const input = {
|
|
131
|
+
* clientToken: "550e8400-e29b-41d4-a716-446655440000",
|
|
132
|
+
* networkId: "12345678",
|
|
133
|
+
* users: [
|
|
134
|
+
* {
|
|
135
|
+
* codeValidation: true,
|
|
136
|
+
* firstName: "John",
|
|
137
|
+
* inviteCode: "INVITE123",
|
|
138
|
+
* inviteCodeTtl: 7,
|
|
139
|
+
* lastName: "Doe",
|
|
140
|
+
* securityGroupIds: [
|
|
141
|
+
* "BCTY8Qhe"
|
|
142
|
+
* ],
|
|
143
|
+
* username: "john.doe@example.com"
|
|
144
|
+
* },
|
|
145
|
+
* {
|
|
146
|
+
* firstName: "Jane",
|
|
147
|
+
* lastName: "Smith",
|
|
148
|
+
* securityGroupIds: [
|
|
149
|
+
* "BCTY8Qhe"
|
|
150
|
+
* ],
|
|
151
|
+
* username: "jane.smith@example.com"
|
|
152
|
+
* }
|
|
153
|
+
* ]
|
|
154
|
+
* };
|
|
155
|
+
* const command = new BatchCreateUserCommand(input);
|
|
156
|
+
* const response = await client.send(command);
|
|
157
|
+
* /* response is
|
|
158
|
+
* {
|
|
159
|
+
* failed: [],
|
|
160
|
+
* successful: [
|
|
161
|
+
* {
|
|
162
|
+
* codeValidation: true,
|
|
163
|
+
* firstName: "John",
|
|
164
|
+
* inviteCode: "INVITE123",
|
|
165
|
+
* isInviteExpired: false,
|
|
166
|
+
* lastName: "Doe",
|
|
167
|
+
* status: 1,
|
|
168
|
+
* userId: "123",
|
|
169
|
+
* username: "john.doe@example.com"
|
|
170
|
+
* },
|
|
171
|
+
* {
|
|
172
|
+
* codeValidation: false,
|
|
173
|
+
* firstName: "Jane",
|
|
174
|
+
* inviteCode: "AUTOGEN456",
|
|
175
|
+
* isInviteExpired: false,
|
|
176
|
+
* lastName: "Smith",
|
|
177
|
+
* status: 1,
|
|
178
|
+
* userId: "456",
|
|
179
|
+
* username: "jane.smith@example.com"
|
|
180
|
+
* }
|
|
181
|
+
* ]
|
|
182
|
+
* }
|
|
183
|
+
* *\/
|
|
184
|
+
* ```
|
|
185
|
+
*
|
|
186
|
+
* @example Partial failure - duplicate user
|
|
187
|
+
* ```javascript
|
|
188
|
+
* //
|
|
189
|
+
* const input = {
|
|
190
|
+
* networkId: "12345678",
|
|
191
|
+
* users: [
|
|
192
|
+
* {
|
|
193
|
+
* firstName: "Alice",
|
|
194
|
+
* lastName: "Johnson",
|
|
195
|
+
* securityGroupIds: [
|
|
196
|
+
* "BCTY8Qhe"
|
|
197
|
+
* ],
|
|
198
|
+
* username: "alice.johnson@example.com"
|
|
199
|
+
* },
|
|
200
|
+
* {
|
|
201
|
+
* firstName: "Bob",
|
|
202
|
+
* lastName: "Wilson",
|
|
203
|
+
* securityGroupIds: [
|
|
204
|
+
* "BCTY8Qhe"
|
|
205
|
+
* ],
|
|
206
|
+
* username: "existing.user@example.com"
|
|
207
|
+
* }
|
|
208
|
+
* ]
|
|
209
|
+
* };
|
|
210
|
+
* const command = new BatchCreateUserCommand(input);
|
|
211
|
+
* const response = await client.send(command);
|
|
212
|
+
* /* response is
|
|
213
|
+
* {
|
|
214
|
+
* failed: [
|
|
215
|
+
* {
|
|
216
|
+
* field: "username",
|
|
217
|
+
* reason: "User already exists",
|
|
218
|
+
* userId: "0"
|
|
219
|
+
* }
|
|
220
|
+
* ],
|
|
221
|
+
* successful: [
|
|
222
|
+
* {
|
|
223
|
+
* codeValidation: false,
|
|
224
|
+
* firstName: "Alice",
|
|
225
|
+
* inviteCode: "AUTOGEN789",
|
|
226
|
+
* isInviteExpired: false,
|
|
227
|
+
* lastName: "Johnson",
|
|
228
|
+
* status: 1,
|
|
229
|
+
* userId: "678",
|
|
230
|
+
* username: "alice.johnson@example.com"
|
|
231
|
+
* }
|
|
232
|
+
* ]
|
|
233
|
+
* }
|
|
234
|
+
* *\/
|
|
235
|
+
* ```
|
|
236
|
+
*
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export declare class BatchCreateUserCommand extends BatchCreateUserCommand_base {
|
|
240
|
+
/** @internal type navigation helper, not in runtime. */
|
|
241
|
+
protected static __types: {
|
|
242
|
+
api: {
|
|
243
|
+
input: BatchCreateUserRequest;
|
|
244
|
+
output: BatchCreateUserResponse;
|
|
245
|
+
};
|
|
246
|
+
sdk: {
|
|
247
|
+
input: BatchCreateUserCommandInput;
|
|
248
|
+
output: BatchCreateUserCommandOutput;
|
|
249
|
+
};
|
|
250
|
+
};
|
|
251
|
+
}
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BatchDeleteUserRequest, BatchDeleteUserResponse } 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 BatchDeleteUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchDeleteUserCommandInput extends BatchDeleteUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchDeleteUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchDeleteUserCommandOutput extends BatchDeleteUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchDeleteUserCommand_base: {
|
|
25
|
+
new (input: BatchDeleteUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteUserCommandInput, BatchDeleteUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: BatchDeleteUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteUserCommandInput, BatchDeleteUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, BatchDeleteUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, BatchDeleteUserCommand } = 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 = { // BatchDeleteUserRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* userIds: [ // UserIds // required
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new BatchDeleteUserCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // BatchDeleteUserResponse
|
|
49
|
+
* // message: "STRING_VALUE",
|
|
50
|
+
* // successful: [ // BatchUserSuccessResponseItems
|
|
51
|
+
* // { // BatchUserSuccessResponseItem
|
|
52
|
+
* // userId: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // failed: [ // BatchUserErrorResponseItems
|
|
56
|
+
* // { // BatchUserErrorResponseItem
|
|
57
|
+
* // field: "STRING_VALUE",
|
|
58
|
+
* // reason: "STRING_VALUE",
|
|
59
|
+
* // userId: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param BatchDeleteUserCommandInput - {@link BatchDeleteUserCommandInput}
|
|
67
|
+
* @returns {@link BatchDeleteUserCommandOutput}
|
|
68
|
+
* @see {@link BatchDeleteUserCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link BatchDeleteUserCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link BadRequestError} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerError} (server fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link RateLimitError} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
88
|
+
* <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>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationError} (client fault)
|
|
91
|
+
* <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>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link WickrServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @example Delete multiple users
|
|
98
|
+
* ```javascript
|
|
99
|
+
* //
|
|
100
|
+
* const input = {
|
|
101
|
+
* clientToken: "6ba7b814-9dad-11d1-80b4-00c04fd430c8",
|
|
102
|
+
* networkId: "12345678",
|
|
103
|
+
* userIds: [
|
|
104
|
+
* "123",
|
|
105
|
+
* "456"
|
|
106
|
+
* ]
|
|
107
|
+
* };
|
|
108
|
+
* const command = new BatchDeleteUserCommand(input);
|
|
109
|
+
* const response = await client.send(command);
|
|
110
|
+
* /* response is
|
|
111
|
+
* {
|
|
112
|
+
* failed: [],
|
|
113
|
+
* message: "success",
|
|
114
|
+
* successful: [
|
|
115
|
+
* {
|
|
116
|
+
* userId: "123"
|
|
117
|
+
* },
|
|
118
|
+
* {
|
|
119
|
+
* userId: "456"
|
|
120
|
+
* }
|
|
121
|
+
* ]
|
|
122
|
+
* }
|
|
123
|
+
* *\/
|
|
124
|
+
* ```
|
|
125
|
+
*
|
|
126
|
+
* @example Partial failure - user not found
|
|
127
|
+
* ```javascript
|
|
128
|
+
* //
|
|
129
|
+
* const input = {
|
|
130
|
+
* networkId: "12345678",
|
|
131
|
+
* userIds: [
|
|
132
|
+
* "123",
|
|
133
|
+
* "456"
|
|
134
|
+
* ]
|
|
135
|
+
* };
|
|
136
|
+
* const command = new BatchDeleteUserCommand(input);
|
|
137
|
+
* const response = await client.send(command);
|
|
138
|
+
* /* response is
|
|
139
|
+
* {
|
|
140
|
+
* failed: [
|
|
141
|
+
* {
|
|
142
|
+
* field: "username",
|
|
143
|
+
* reason: "User not found",
|
|
144
|
+
* userId: "456"
|
|
145
|
+
* }
|
|
146
|
+
* ],
|
|
147
|
+
* message: "partial success",
|
|
148
|
+
* successful: [
|
|
149
|
+
* {
|
|
150
|
+
* userId: "123"
|
|
151
|
+
* }
|
|
152
|
+
* ]
|
|
153
|
+
* }
|
|
154
|
+
* *\/
|
|
155
|
+
* ```
|
|
156
|
+
*
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
export declare class BatchDeleteUserCommand extends BatchDeleteUserCommand_base {
|
|
160
|
+
/** @internal type navigation helper, not in runtime. */
|
|
161
|
+
protected static __types: {
|
|
162
|
+
api: {
|
|
163
|
+
input: BatchDeleteUserRequest;
|
|
164
|
+
output: BatchDeleteUserResponse;
|
|
165
|
+
};
|
|
166
|
+
sdk: {
|
|
167
|
+
input: BatchDeleteUserCommandInput;
|
|
168
|
+
output: BatchDeleteUserCommandOutput;
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
}
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BatchLookupUserUnameRequest, BatchLookupUserUnameResponse } 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 BatchLookupUserUnameCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchLookupUserUnameCommandInput extends BatchLookupUserUnameRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchLookupUserUnameCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchLookupUserUnameCommandOutput extends BatchLookupUserUnameResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchLookupUserUnameCommand_base: {
|
|
25
|
+
new (input: BatchLookupUserUnameCommandInput): import("@smithy/smithy-client").CommandImpl<BatchLookupUserUnameCommandInput, BatchLookupUserUnameCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: BatchLookupUserUnameCommandInput): import("@smithy/smithy-client").CommandImpl<BatchLookupUserUnameCommandInput, BatchLookupUserUnameCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, BatchLookupUserUnameCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, BatchLookupUserUnameCommand } = 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 = { // BatchLookupUserUnameRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* unames: [ // Unames // required
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new BatchLookupUserUnameCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // BatchLookupUserUnameResponse
|
|
49
|
+
* // message: "STRING_VALUE",
|
|
50
|
+
* // successful: [ // BatchUnameSuccessResponseItems
|
|
51
|
+
* // { // BatchUnameSuccessResponseItem
|
|
52
|
+
* // uname: "STRING_VALUE", // required
|
|
53
|
+
* // username: "STRING_VALUE", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // failed: [ // BatchUnameErrorResponseItems
|
|
57
|
+
* // { // BatchUnameErrorResponseItem
|
|
58
|
+
* // field: "STRING_VALUE",
|
|
59
|
+
* // reason: "STRING_VALUE",
|
|
60
|
+
* // uname: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param BatchLookupUserUnameCommandInput - {@link BatchLookupUserUnameCommandInput}
|
|
68
|
+
* @returns {@link BatchLookupUserUnameCommandOutput}
|
|
69
|
+
* @see {@link BatchLookupUserUnameCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link BatchLookupUserUnameCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link BadRequestError} (client fault)
|
|
74
|
+
* <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>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServerError} (server fault)
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link RateLimitError} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
86
|
+
* <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>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationError} (client fault)
|
|
92
|
+
* <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>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link WickrServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
96
|
+
*
|
|
97
|
+
*
|
|
98
|
+
* @example Lookup multiple user unames
|
|
99
|
+
* ```javascript
|
|
100
|
+
* //
|
|
101
|
+
* const input = {
|
|
102
|
+
* clientToken: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
103
|
+
* networkId: "12345678",
|
|
104
|
+
* unames: [
|
|
105
|
+
* "a1b2c3d4e5f6",
|
|
106
|
+
* "g7h8i9j0k1l2"
|
|
107
|
+
* ]
|
|
108
|
+
* };
|
|
109
|
+
* const command = new BatchLookupUserUnameCommand(input);
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response is
|
|
112
|
+
* {
|
|
113
|
+
* failed: [],
|
|
114
|
+
* message: "success",
|
|
115
|
+
* successful: [
|
|
116
|
+
* {
|
|
117
|
+
* uname: "a1b2c3d4e5f6",
|
|
118
|
+
* username: "john.doe@example.com"
|
|
119
|
+
* },
|
|
120
|
+
* {
|
|
121
|
+
* uname: "g7h8i9j0k1l2",
|
|
122
|
+
* username: "john.doe2@example.com"
|
|
123
|
+
* }
|
|
124
|
+
* ]
|
|
125
|
+
* }
|
|
126
|
+
* *\/
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
129
|
+
* @example Partial failure - uname not found
|
|
130
|
+
* ```javascript
|
|
131
|
+
* //
|
|
132
|
+
* const input = {
|
|
133
|
+
* networkId: "12345678",
|
|
134
|
+
* unames: [
|
|
135
|
+
* "a1b2c3d4e5f6",
|
|
136
|
+
* "invaliduname"
|
|
137
|
+
* ]
|
|
138
|
+
* };
|
|
139
|
+
* const command = new BatchLookupUserUnameCommand(input);
|
|
140
|
+
* const response = await client.send(command);
|
|
141
|
+
* /* response is
|
|
142
|
+
* {
|
|
143
|
+
* failed: [
|
|
144
|
+
* {
|
|
145
|
+
* field: "uname",
|
|
146
|
+
* reason: "Uname not found",
|
|
147
|
+
* uname: "invaliduname"
|
|
148
|
+
* }
|
|
149
|
+
* ],
|
|
150
|
+
* message: "partial success",
|
|
151
|
+
* successful: [
|
|
152
|
+
* {
|
|
153
|
+
* uname: "a1b2c3d4e5f6",
|
|
154
|
+
* username: "john.doe@example.com"
|
|
155
|
+
* }
|
|
156
|
+
* ]
|
|
157
|
+
* }
|
|
158
|
+
* *\/
|
|
159
|
+
* ```
|
|
160
|
+
*
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
export declare class BatchLookupUserUnameCommand extends BatchLookupUserUnameCommand_base {
|
|
164
|
+
/** @internal type navigation helper, not in runtime. */
|
|
165
|
+
protected static __types: {
|
|
166
|
+
api: {
|
|
167
|
+
input: BatchLookupUserUnameRequest;
|
|
168
|
+
output: BatchLookupUserUnameResponse;
|
|
169
|
+
};
|
|
170
|
+
sdk: {
|
|
171
|
+
input: BatchLookupUserUnameCommandInput;
|
|
172
|
+
output: BatchLookupUserUnameCommandOutput;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
}
|