@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,155 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetGuestUserHistoryCountRequest, GetGuestUserHistoryCountResponse } 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 GetGuestUserHistoryCountCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetGuestUserHistoryCountCommandInput extends GetGuestUserHistoryCountRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetGuestUserHistoryCountCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetGuestUserHistoryCountCommandOutput extends GetGuestUserHistoryCountResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetGuestUserHistoryCountCommand_base: {
|
|
25
|
+
new (input: GetGuestUserHistoryCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetGuestUserHistoryCountCommandInput, GetGuestUserHistoryCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetGuestUserHistoryCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetGuestUserHistoryCountCommandInput, GetGuestUserHistoryCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetGuestUserHistoryCountCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetGuestUserHistoryCountCommand } = 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 = { // GetGuestUserHistoryCountRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetGuestUserHistoryCountCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetGuestUserHistoryCountResponse
|
|
45
|
+
* // history: [ // GuestUserHistoryCountList // required
|
|
46
|
+
* // { // GuestUserHistoryCount
|
|
47
|
+
* // month: "STRING_VALUE", // required
|
|
48
|
+
* // count: "STRING_VALUE", // required
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetGuestUserHistoryCountCommandInput - {@link GetGuestUserHistoryCountCommandInput}
|
|
56
|
+
* @returns {@link GetGuestUserHistoryCountCommandOutput}
|
|
57
|
+
* @see {@link GetGuestUserHistoryCountCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetGuestUserHistoryCountCommandOutput} 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 guest user history count
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* networkId: "12345678"
|
|
91
|
+
* };
|
|
92
|
+
* const command = new GetGuestUserHistoryCountCommand(input);
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* {
|
|
96
|
+
* history: [
|
|
97
|
+
* {
|
|
98
|
+
* count: "32",
|
|
99
|
+
* month: "2024_01"
|
|
100
|
+
* },
|
|
101
|
+
* {
|
|
102
|
+
* count: "28",
|
|
103
|
+
* month: "2023_12"
|
|
104
|
+
* },
|
|
105
|
+
* {
|
|
106
|
+
* count: "35",
|
|
107
|
+
* month: "2023_11"
|
|
108
|
+
* },
|
|
109
|
+
* {
|
|
110
|
+
* count: "22",
|
|
111
|
+
* month: "2023_10"
|
|
112
|
+
* },
|
|
113
|
+
* {
|
|
114
|
+
* count: "18",
|
|
115
|
+
* month: "2023_09"
|
|
116
|
+
* },
|
|
117
|
+
* {
|
|
118
|
+
* count: "15",
|
|
119
|
+
* month: "2023_08"
|
|
120
|
+
* }
|
|
121
|
+
* ]
|
|
122
|
+
* }
|
|
123
|
+
* *\/
|
|
124
|
+
* ```
|
|
125
|
+
*
|
|
126
|
+
* @example Empty response for network with no guest user history
|
|
127
|
+
* ```javascript
|
|
128
|
+
* //
|
|
129
|
+
* const input = {
|
|
130
|
+
* networkId: "87654321"
|
|
131
|
+
* };
|
|
132
|
+
* const command = new GetGuestUserHistoryCountCommand(input);
|
|
133
|
+
* const response = await client.send(command);
|
|
134
|
+
* /* response is
|
|
135
|
+
* {
|
|
136
|
+
* history: []
|
|
137
|
+
* }
|
|
138
|
+
* *\/
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
export declare class GetGuestUserHistoryCountCommand extends GetGuestUserHistoryCountCommand_base {
|
|
144
|
+
/** @internal type navigation helper, not in runtime. */
|
|
145
|
+
protected static __types: {
|
|
146
|
+
api: {
|
|
147
|
+
input: GetGuestUserHistoryCountRequest;
|
|
148
|
+
output: GetGuestUserHistoryCountResponse;
|
|
149
|
+
};
|
|
150
|
+
sdk: {
|
|
151
|
+
input: GetGuestUserHistoryCountCommandInput;
|
|
152
|
+
output: GetGuestUserHistoryCountCommandOutput;
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetNetworkRequest, GetNetworkResponse } 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 GetNetworkCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetNetworkCommandInput extends GetNetworkRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetNetworkCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetNetworkCommandOutput extends GetNetworkResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetNetworkCommand_base: {
|
|
25
|
+
new (input: GetNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<GetNetworkCommandInput, GetNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetNetworkCommandInput): import("@smithy/smithy-client").CommandImpl<GetNetworkCommandInput, GetNetworkCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves detailed information about a specific Wickr network, including its configuration, access level, and 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, GetNetworkCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetNetworkCommand } = 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 = { // GetNetworkRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetNetworkCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetNetworkResponse
|
|
45
|
+
* // networkId: "STRING_VALUE", // required
|
|
46
|
+
* // networkName: "STRING_VALUE", // required
|
|
47
|
+
* // accessLevel: "STANDARD" || "PREMIUM", // required
|
|
48
|
+
* // awsAccountId: "STRING_VALUE", // required
|
|
49
|
+
* // networkArn: "STRING_VALUE", // required
|
|
50
|
+
* // standing: Number("int"),
|
|
51
|
+
* // freeTrialExpiration: "STRING_VALUE",
|
|
52
|
+
* // migrationState: Number("int"),
|
|
53
|
+
* // encryptionKeyArn: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetNetworkCommandInput - {@link GetNetworkCommandInput}
|
|
59
|
+
* @returns {@link GetNetworkCommandOutput}
|
|
60
|
+
* @see {@link GetNetworkCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetNetworkCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link BadRequestError} (client fault)
|
|
65
|
+
* <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>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
68
|
+
* <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>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerError} (server fault)
|
|
71
|
+
* <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>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link RateLimitError} (client fault)
|
|
74
|
+
* <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>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationError} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link WickrServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @example Get network successfully
|
|
90
|
+
* ```javascript
|
|
91
|
+
* //
|
|
92
|
+
* const input = {
|
|
93
|
+
* networkId: "12345678"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new GetNetworkCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response is
|
|
98
|
+
* {
|
|
99
|
+
* accessLevel: "PREMIUM",
|
|
100
|
+
* awsAccountId: "123456789012",
|
|
101
|
+
* migrationState: 0,
|
|
102
|
+
* networkArn: "arn:aws:wickr:us-east-1:123456789012:network/12345678",
|
|
103
|
+
* networkId: "12345678",
|
|
104
|
+
* networkName: "Production Network",
|
|
105
|
+
* standing: 1
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @example Get network - not found
|
|
111
|
+
* ```javascript
|
|
112
|
+
* //
|
|
113
|
+
* const input = {
|
|
114
|
+
* networkId: "99999999"
|
|
115
|
+
* };
|
|
116
|
+
* const command = new GetNetworkCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response is
|
|
119
|
+
* { /* metadata only *\/ }
|
|
120
|
+
* *\/
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export declare class GetNetworkCommand extends GetNetworkCommand_base {
|
|
126
|
+
/** @internal type navigation helper, not in runtime. */
|
|
127
|
+
protected static __types: {
|
|
128
|
+
api: {
|
|
129
|
+
input: GetNetworkRequest;
|
|
130
|
+
output: GetNetworkResponse;
|
|
131
|
+
};
|
|
132
|
+
sdk: {
|
|
133
|
+
input: GetNetworkCommandInput;
|
|
134
|
+
output: GetNetworkCommandOutput;
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
}
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetNetworkSettingsRequest, GetNetworkSettingsResponse } 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 GetNetworkSettingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetNetworkSettingsCommandInput extends GetNetworkSettingsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetNetworkSettingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetNetworkSettingsCommandOutput extends GetNetworkSettingsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetNetworkSettingsCommand_base: {
|
|
25
|
+
new (input: GetNetworkSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetNetworkSettingsCommandInput, GetNetworkSettingsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetNetworkSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetNetworkSettingsCommandInput, GetNetworkSettingsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetNetworkSettingsCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetNetworkSettingsCommand } = 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 = { // GetNetworkSettingsRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetNetworkSettingsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetNetworkSettingsResponse
|
|
45
|
+
* // settings: [ // SettingsList // required
|
|
46
|
+
* // { // Setting
|
|
47
|
+
* // optionName: "STRING_VALUE", // required
|
|
48
|
+
* // value: "STRING_VALUE", // required
|
|
49
|
+
* // type: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param GetNetworkSettingsCommandInput - {@link GetNetworkSettingsCommandInput}
|
|
57
|
+
* @returns {@link GetNetworkSettingsCommandOutput}
|
|
58
|
+
* @see {@link GetNetworkSettingsCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link GetNetworkSettingsCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link BadRequestError} (client fault)
|
|
63
|
+
* <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>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
66
|
+
* <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>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
* <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>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link RateLimitError} (client fault)
|
|
72
|
+
* <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>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
75
|
+
* <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>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationError} (client fault)
|
|
81
|
+
* <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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link WickrServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @example Get network settings with mixed value types
|
|
88
|
+
* ```javascript
|
|
89
|
+
* //
|
|
90
|
+
* const input = {
|
|
91
|
+
* networkId: "12345678"
|
|
92
|
+
* };
|
|
93
|
+
* const command = new GetNetworkSettingsCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* {
|
|
97
|
+
* settings: [
|
|
98
|
+
* {
|
|
99
|
+
* optionName: "enableClientMetrics",
|
|
100
|
+
* type: "boolean",
|
|
101
|
+
* value: "true"
|
|
102
|
+
* },
|
|
103
|
+
* {
|
|
104
|
+
* optionName: "dataRetention",
|
|
105
|
+
* type: "boolean",
|
|
106
|
+
* value: "true"
|
|
107
|
+
* }
|
|
108
|
+
* ]
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @example Get settings for network with defaults only
|
|
114
|
+
* ```javascript
|
|
115
|
+
* //
|
|
116
|
+
* const input = {
|
|
117
|
+
* networkId: "87654321"
|
|
118
|
+
* };
|
|
119
|
+
* const command = new GetNetworkSettingsCommand(input);
|
|
120
|
+
* const response = await client.send(command);
|
|
121
|
+
* /* response is
|
|
122
|
+
* {
|
|
123
|
+
* settings: [
|
|
124
|
+
* {
|
|
125
|
+
* optionName: "enableClientMetrics",
|
|
126
|
+
* type: "boolean",
|
|
127
|
+
* value: "false"
|
|
128
|
+
* },
|
|
129
|
+
* {
|
|
130
|
+
* optionName: "dataRetention",
|
|
131
|
+
* type: "boolean",
|
|
132
|
+
* value: "false"
|
|
133
|
+
* }
|
|
134
|
+
* ]
|
|
135
|
+
* }
|
|
136
|
+
* *\/
|
|
137
|
+
* ```
|
|
138
|
+
*
|
|
139
|
+
* @example Network not found error
|
|
140
|
+
* ```javascript
|
|
141
|
+
* //
|
|
142
|
+
* const input = {
|
|
143
|
+
* networkId: "99999999"
|
|
144
|
+
* };
|
|
145
|
+
* const command = new GetNetworkSettingsCommand(input);
|
|
146
|
+
* const response = await client.send(command);
|
|
147
|
+
* /* response is
|
|
148
|
+
* { /* metadata only *\/ }
|
|
149
|
+
* *\/
|
|
150
|
+
* ```
|
|
151
|
+
*
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export declare class GetNetworkSettingsCommand extends GetNetworkSettingsCommand_base {
|
|
155
|
+
/** @internal type navigation helper, not in runtime. */
|
|
156
|
+
protected static __types: {
|
|
157
|
+
api: {
|
|
158
|
+
input: GetNetworkSettingsRequest;
|
|
159
|
+
output: GetNetworkSettingsResponse;
|
|
160
|
+
};
|
|
161
|
+
sdk: {
|
|
162
|
+
input: GetNetworkSettingsCommandInput;
|
|
163
|
+
output: GetNetworkSettingsCommandOutput;
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetOidcInfoRequest, GetOidcInfoResponse } 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 GetOidcInfoCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOidcInfoCommandInput extends GetOidcInfoRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOidcInfoCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOidcInfoCommandOutput extends GetOidcInfoResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOidcInfoCommand_base: {
|
|
25
|
+
new (input: GetOidcInfoCommandInput): import("@smithy/smithy-client").CommandImpl<GetOidcInfoCommandInput, GetOidcInfoCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetOidcInfoCommandInput): import("@smithy/smithy-client").CommandImpl<GetOidcInfoCommandInput, GetOidcInfoCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, GetOidcInfoCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, GetOidcInfoCommand } = 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 = { // GetOidcInfoRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* clientId: "STRING_VALUE",
|
|
42
|
+
* code: "STRING_VALUE",
|
|
43
|
+
* grantType: "STRING_VALUE",
|
|
44
|
+
* redirectUri: "STRING_VALUE",
|
|
45
|
+
* url: "STRING_VALUE",
|
|
46
|
+
* clientSecret: "STRING_VALUE",
|
|
47
|
+
* codeVerifier: "STRING_VALUE",
|
|
48
|
+
* certificate: "STRING_VALUE",
|
|
49
|
+
* };
|
|
50
|
+
* const command = new GetOidcInfoCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // GetOidcInfoResponse
|
|
53
|
+
* // openidConnectInfo: { // OidcConfigInfo
|
|
54
|
+
* // applicationName: "STRING_VALUE",
|
|
55
|
+
* // clientId: "STRING_VALUE",
|
|
56
|
+
* // companyId: "STRING_VALUE", // required
|
|
57
|
+
* // scopes: "STRING_VALUE", // required
|
|
58
|
+
* // issuer: "STRING_VALUE", // required
|
|
59
|
+
* // clientSecret: "STRING_VALUE",
|
|
60
|
+
* // secret: "STRING_VALUE",
|
|
61
|
+
* // redirectUrl: "STRING_VALUE",
|
|
62
|
+
* // userId: "STRING_VALUE",
|
|
63
|
+
* // customUsername: "STRING_VALUE",
|
|
64
|
+
* // caCertificate: "STRING_VALUE",
|
|
65
|
+
* // applicationId: Number("int"),
|
|
66
|
+
* // ssoTokenBufferMinutes: Number("int"),
|
|
67
|
+
* // extraAuthParams: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // tokenInfo: { // OidcTokenInfo
|
|
70
|
+
* // codeVerifier: "STRING_VALUE",
|
|
71
|
+
* // codeChallenge: "STRING_VALUE",
|
|
72
|
+
* // accessToken: "STRING_VALUE",
|
|
73
|
+
* // idToken: "STRING_VALUE",
|
|
74
|
+
* // refreshToken: "STRING_VALUE",
|
|
75
|
+
* // tokenType: "STRING_VALUE",
|
|
76
|
+
* // expiresIn: Number("long"),
|
|
77
|
+
* // },
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param GetOidcInfoCommandInput - {@link GetOidcInfoCommandInput}
|
|
83
|
+
* @returns {@link GetOidcInfoCommandOutput}
|
|
84
|
+
* @see {@link GetOidcInfoCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link GetOidcInfoCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link BadRequestError} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
92
|
+
* <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>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link InternalServerError} (server fault)
|
|
95
|
+
* <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>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link RateLimitError} (client fault)
|
|
98
|
+
* <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>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
101
|
+
* <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>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
104
|
+
* <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>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationError} (client fault)
|
|
107
|
+
* <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>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link WickrServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
111
|
+
*
|
|
112
|
+
*
|
|
113
|
+
* @example Get OIDC info successfully
|
|
114
|
+
* ```javascript
|
|
115
|
+
* //
|
|
116
|
+
* const input = {
|
|
117
|
+
* networkId: "12345678"
|
|
118
|
+
* };
|
|
119
|
+
* const command = new GetOidcInfoCommand(input);
|
|
120
|
+
* const response = await client.send(command);
|
|
121
|
+
* /* response is
|
|
122
|
+
* {
|
|
123
|
+
* openidConnectInfo: {
|
|
124
|
+
* clientId: "client123",
|
|
125
|
+
* companyId: "us-east-1-company123",
|
|
126
|
+
* issuer: "https://login.example.com",
|
|
127
|
+
* redirectUrl: "https://app.wickr.com/callback",
|
|
128
|
+
* scopes: "openid profile email",
|
|
129
|
+
* ssoTokenBufferMinutes: 5,
|
|
130
|
+
* userId: "email"
|
|
131
|
+
* }
|
|
132
|
+
* }
|
|
133
|
+
* *\/
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
136
|
+
* @example Get OIDC info - not configured
|
|
137
|
+
* ```javascript
|
|
138
|
+
* //
|
|
139
|
+
* const input = {
|
|
140
|
+
* networkId: "12345678"
|
|
141
|
+
* };
|
|
142
|
+
* const command = new GetOidcInfoCommand(input);
|
|
143
|
+
* const response = await client.send(command);
|
|
144
|
+
* /* response is
|
|
145
|
+
* {
|
|
146
|
+
* openidConnectInfo: {
|
|
147
|
+
* companyId: "",
|
|
148
|
+
* issuer: "",
|
|
149
|
+
* scopes: ""
|
|
150
|
+
* }
|
|
151
|
+
* }
|
|
152
|
+
* *\/
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export declare class GetOidcInfoCommand extends GetOidcInfoCommand_base {
|
|
158
|
+
/** @internal type navigation helper, not in runtime. */
|
|
159
|
+
protected static __types: {
|
|
160
|
+
api: {
|
|
161
|
+
input: GetOidcInfoRequest;
|
|
162
|
+
output: GetOidcInfoResponse;
|
|
163
|
+
};
|
|
164
|
+
sdk: {
|
|
165
|
+
input: GetOidcInfoCommandInput;
|
|
166
|
+
output: GetOidcInfoCommandOutput;
|
|
167
|
+
};
|
|
168
|
+
};
|
|
169
|
+
}
|