@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,185 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListBlockedGuestUsersRequest, ListBlockedGuestUsersResponse } 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 ListBlockedGuestUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListBlockedGuestUsersCommandInput extends ListBlockedGuestUsersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListBlockedGuestUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListBlockedGuestUsersCommandOutput extends ListBlockedGuestUsersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListBlockedGuestUsersCommand_base: {
|
|
25
|
+
new (input: ListBlockedGuestUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListBlockedGuestUsersCommandInput, ListBlockedGuestUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListBlockedGuestUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListBlockedGuestUsersCommandInput, ListBlockedGuestUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, ListBlockedGuestUsersCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, ListBlockedGuestUsersCommand } = 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 = { // ListBlockedGuestUsersRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* sortDirection: "ASC" || "DESC",
|
|
43
|
+
* sortFields: "STRING_VALUE",
|
|
44
|
+
* username: "STRING_VALUE",
|
|
45
|
+
* admin: "STRING_VALUE",
|
|
46
|
+
* nextToken: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new ListBlockedGuestUsersCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // ListBlockedGuestUsersResponse
|
|
51
|
+
* // nextToken: "STRING_VALUE",
|
|
52
|
+
* // blocklist: [ // BlockedGuestUserList // required
|
|
53
|
+
* // { // BlockedGuestUser
|
|
54
|
+
* // username: "STRING_VALUE", // required
|
|
55
|
+
* // admin: "STRING_VALUE", // required
|
|
56
|
+
* // modified: "STRING_VALUE", // required
|
|
57
|
+
* // usernameHash: "STRING_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param ListBlockedGuestUsersCommandInput - {@link ListBlockedGuestUsersCommandInput}
|
|
65
|
+
* @returns {@link ListBlockedGuestUsersCommandOutput}
|
|
66
|
+
* @see {@link ListBlockedGuestUsersCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link ListBlockedGuestUsersCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link BadRequestError} (client fault)
|
|
71
|
+
* <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>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
74
|
+
* <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>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InternalServerError} (server fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link RateLimitError} (client fault)
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
86
|
+
* <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>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ValidationError} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link WickrServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* @example Get paginated list of blocked guest users
|
|
96
|
+
* ```javascript
|
|
97
|
+
* //
|
|
98
|
+
* const input = {
|
|
99
|
+
* maxResults: 10,
|
|
100
|
+
* networkId: "12345678",
|
|
101
|
+
* sortDirection: "DESC",
|
|
102
|
+
* sortFields: "modified"
|
|
103
|
+
* };
|
|
104
|
+
* const command = new ListBlockedGuestUsersCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response is
|
|
107
|
+
* {
|
|
108
|
+
* blocklist: [
|
|
109
|
+
* {
|
|
110
|
+
* admin: "admin@company.com",
|
|
111
|
+
* modified: "2024-01-15 10:30:00",
|
|
112
|
+
* username: "blocked.user1@example.com",
|
|
113
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
114
|
+
* },
|
|
115
|
+
* {
|
|
116
|
+
* admin: "admin@company.com",
|
|
117
|
+
* modified: "2024-01-10 14:20:00",
|
|
118
|
+
* username: "blocked.user2@example.com",
|
|
119
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
120
|
+
* },
|
|
121
|
+
* {
|
|
122
|
+
* admin: "security@company.com",
|
|
123
|
+
* modified: "2024-01-05 09:15:00",
|
|
124
|
+
* username: "blocked.user3@example.com",
|
|
125
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
126
|
+
* }
|
|
127
|
+
* ],
|
|
128
|
+
* nextToken: "v1:pagination:f47ac10b-58cc-4372-a567-0e02b2c3d479"
|
|
129
|
+
* }
|
|
130
|
+
* *\/
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
133
|
+
* @example Filter by username
|
|
134
|
+
* ```javascript
|
|
135
|
+
* //
|
|
136
|
+
* const input = {
|
|
137
|
+
* networkId: "12345678",
|
|
138
|
+
* username: "john.doe@example.com"
|
|
139
|
+
* };
|
|
140
|
+
* const command = new ListBlockedGuestUsersCommand(input);
|
|
141
|
+
* const response = await client.send(command);
|
|
142
|
+
* /* response is
|
|
143
|
+
* {
|
|
144
|
+
* blocklist: [
|
|
145
|
+
* {
|
|
146
|
+
* admin: "admin@company.com",
|
|
147
|
+
* modified: "2023-12-20 16:45:00",
|
|
148
|
+
* username: "john.doe@example.com",
|
|
149
|
+
* usernameHash: "032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d"
|
|
150
|
+
* }
|
|
151
|
+
* ]
|
|
152
|
+
* }
|
|
153
|
+
* *\/
|
|
154
|
+
* ```
|
|
155
|
+
*
|
|
156
|
+
* @example Empty blocklist
|
|
157
|
+
* ```javascript
|
|
158
|
+
* //
|
|
159
|
+
* const input = {
|
|
160
|
+
* networkId: "12345678"
|
|
161
|
+
* };
|
|
162
|
+
* const command = new ListBlockedGuestUsersCommand(input);
|
|
163
|
+
* const response = await client.send(command);
|
|
164
|
+
* /* response is
|
|
165
|
+
* {
|
|
166
|
+
* blocklist: []
|
|
167
|
+
* }
|
|
168
|
+
* *\/
|
|
169
|
+
* ```
|
|
170
|
+
*
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
export declare class ListBlockedGuestUsersCommand extends ListBlockedGuestUsersCommand_base {
|
|
174
|
+
/** @internal type navigation helper, not in runtime. */
|
|
175
|
+
protected static __types: {
|
|
176
|
+
api: {
|
|
177
|
+
input: ListBlockedGuestUsersRequest;
|
|
178
|
+
output: ListBlockedGuestUsersResponse;
|
|
179
|
+
};
|
|
180
|
+
sdk: {
|
|
181
|
+
input: ListBlockedGuestUsersCommandInput;
|
|
182
|
+
output: ListBlockedGuestUsersCommandOutput;
|
|
183
|
+
};
|
|
184
|
+
};
|
|
185
|
+
}
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListBotsRequest, ListBotsResponse } 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 ListBotsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListBotsCommandInput extends ListBotsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListBotsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListBotsCommandOutput extends ListBotsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListBotsCommand_base: {
|
|
25
|
+
new (input: ListBotsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBotsCommandInput, ListBotsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListBotsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBotsCommandInput, ListBotsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, ListBotsCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, ListBotsCommand } = 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 = { // ListBotsRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* maxResults: Number("int"),
|
|
43
|
+
* sortFields: "STRING_VALUE",
|
|
44
|
+
* sortDirection: "ASC" || "DESC",
|
|
45
|
+
* displayName: "STRING_VALUE",
|
|
46
|
+
* username: "STRING_VALUE",
|
|
47
|
+
* status: 1 || 2,
|
|
48
|
+
* groupId: "STRING_VALUE",
|
|
49
|
+
* };
|
|
50
|
+
* const command = new ListBotsCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // ListBotsResponse
|
|
53
|
+
* // bots: [ // Bots // required
|
|
54
|
+
* // { // Bot
|
|
55
|
+
* // botId: "STRING_VALUE",
|
|
56
|
+
* // displayName: "STRING_VALUE",
|
|
57
|
+
* // username: "STRING_VALUE",
|
|
58
|
+
* // uname: "STRING_VALUE",
|
|
59
|
+
* // pubkey: "STRING_VALUE",
|
|
60
|
+
* // status: 1 || 2,
|
|
61
|
+
* // groupId: "STRING_VALUE",
|
|
62
|
+
* // hasChallenge: true || false,
|
|
63
|
+
* // suspended: true || false,
|
|
64
|
+
* // lastLogin: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // nextToken: "STRING_VALUE",
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param ListBotsCommandInput - {@link ListBotsCommandInput}
|
|
73
|
+
* @returns {@link ListBotsCommandOutput}
|
|
74
|
+
* @see {@link ListBotsCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link ListBotsCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link BadRequestError} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalServerError} (server fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link RateLimitError} (client fault)
|
|
88
|
+
* <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>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
91
|
+
* <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>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
94
|
+
* <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>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ValidationError} (client fault)
|
|
97
|
+
* <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>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link WickrServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @example List bots with pagination
|
|
104
|
+
* ```javascript
|
|
105
|
+
* //
|
|
106
|
+
* const input = {
|
|
107
|
+
* maxResults: 10,
|
|
108
|
+
* networkId: "12345678",
|
|
109
|
+
* sortDirection: "ASC",
|
|
110
|
+
* sortFields: "username"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new ListBotsCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* bots: [
|
|
117
|
+
* {
|
|
118
|
+
* botId: "98765",
|
|
119
|
+
* displayName: "Analytics Bot",
|
|
120
|
+
* groupId: "analytics_group",
|
|
121
|
+
* hasChallenge: true,
|
|
122
|
+
* lastLogin: "1704067200",
|
|
123
|
+
* pubkey: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF4",
|
|
124
|
+
* status: 2,
|
|
125
|
+
* suspended: false,
|
|
126
|
+
* uname: "abc123def456",
|
|
127
|
+
* username: "analytics_bot"
|
|
128
|
+
* },
|
|
129
|
+
* {
|
|
130
|
+
* botId: "98766",
|
|
131
|
+
* displayName: "Support Bot",
|
|
132
|
+
* groupId: "support_group",
|
|
133
|
+
* hasChallenge: true,
|
|
134
|
+
* lastLogin: "1704153600",
|
|
135
|
+
* pubkey: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5",
|
|
136
|
+
* status: 2,
|
|
137
|
+
* suspended: false,
|
|
138
|
+
* uname: "def456ghi789",
|
|
139
|
+
* username: "support_bot"
|
|
140
|
+
* }
|
|
141
|
+
* ],
|
|
142
|
+
* nextToken: "eyJzdGFydEluZGV4IjoxMH0="
|
|
143
|
+
* }
|
|
144
|
+
* *\/
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* @example List bots with filters
|
|
148
|
+
* ```javascript
|
|
149
|
+
* //
|
|
150
|
+
* const input = {
|
|
151
|
+
* displayName: "Support",
|
|
152
|
+
* maxResults: 10,
|
|
153
|
+
* networkId: "12345678",
|
|
154
|
+
* status: 2
|
|
155
|
+
* };
|
|
156
|
+
* const command = new ListBotsCommand(input);
|
|
157
|
+
* const response = await client.send(command);
|
|
158
|
+
* /* response is
|
|
159
|
+
* {
|
|
160
|
+
* bots: [
|
|
161
|
+
* {
|
|
162
|
+
* botId: "98766",
|
|
163
|
+
* displayName: "Support Bot",
|
|
164
|
+
* groupId: "support_group",
|
|
165
|
+
* hasChallenge: true,
|
|
166
|
+
* lastLogin: "1704153600",
|
|
167
|
+
* pubkey: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5",
|
|
168
|
+
* status: 2,
|
|
169
|
+
* suspended: false,
|
|
170
|
+
* uname: "def456ghi789",
|
|
171
|
+
* username: "support_bot"
|
|
172
|
+
* }
|
|
173
|
+
* ]
|
|
174
|
+
* }
|
|
175
|
+
* *\/
|
|
176
|
+
* ```
|
|
177
|
+
*
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
export declare class ListBotsCommand extends ListBotsCommand_base {
|
|
181
|
+
/** @internal type navigation helper, not in runtime. */
|
|
182
|
+
protected static __types: {
|
|
183
|
+
api: {
|
|
184
|
+
input: ListBotsRequest;
|
|
185
|
+
output: ListBotsResponse;
|
|
186
|
+
};
|
|
187
|
+
sdk: {
|
|
188
|
+
input: ListBotsCommandInput;
|
|
189
|
+
output: ListBotsCommandOutput;
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListDevicesForUserRequest, ListDevicesForUserResponse } 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 ListDevicesForUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListDevicesForUserCommandInput extends ListDevicesForUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListDevicesForUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListDevicesForUserCommandOutput extends ListDevicesForUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListDevicesForUserCommand_base: {
|
|
25
|
+
new (input: ListDevicesForUserCommandInput): import("@smithy/smithy-client").CommandImpl<ListDevicesForUserCommandInput, ListDevicesForUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListDevicesForUserCommandInput): import("@smithy/smithy-client").CommandImpl<ListDevicesForUserCommandInput, ListDevicesForUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, ListDevicesForUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, ListDevicesForUserCommand } = 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 = { // ListDevicesForUserRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* userId: "STRING_VALUE", // required
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* maxResults: Number("int"),
|
|
44
|
+
* sortFields: "STRING_VALUE",
|
|
45
|
+
* sortDirection: "ASC" || "DESC",
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListDevicesForUserCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ListDevicesForUserResponse
|
|
50
|
+
* // nextToken: "STRING_VALUE",
|
|
51
|
+
* // devices: [ // Devices // required
|
|
52
|
+
* // { // BasicDeviceObject
|
|
53
|
+
* // appId: "STRING_VALUE",
|
|
54
|
+
* // created: "STRING_VALUE",
|
|
55
|
+
* // lastLogin: "STRING_VALUE",
|
|
56
|
+
* // statusText: "STRING_VALUE",
|
|
57
|
+
* // suspend: true || false,
|
|
58
|
+
* // type: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param ListDevicesForUserCommandInput - {@link ListDevicesForUserCommandInput}
|
|
66
|
+
* @returns {@link ListDevicesForUserCommandOutput}
|
|
67
|
+
* @see {@link ListDevicesForUserCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link ListDevicesForUserCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link BadRequestError} (client fault)
|
|
72
|
+
* <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>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
75
|
+
* <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>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerError} (server fault)
|
|
78
|
+
* <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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link RateLimitError} (client fault)
|
|
81
|
+
* <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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
84
|
+
* <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>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
87
|
+
* <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>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationError} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link WickrServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @example Successful device list retrieval
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* maxResults: 10,
|
|
101
|
+
* networkId: "12345678",
|
|
102
|
+
* sortDirection: "DESC",
|
|
103
|
+
* sortFields: "appId",
|
|
104
|
+
* userId: "12345"
|
|
105
|
+
* };
|
|
106
|
+
* const command = new ListDevicesForUserCommand(input);
|
|
107
|
+
* const response = await client.send(command);
|
|
108
|
+
* /* response is
|
|
109
|
+
* {
|
|
110
|
+
* devices: [
|
|
111
|
+
* {
|
|
112
|
+
* appId: "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6",
|
|
113
|
+
* created: "January 15th 2024, 2:30:45 pm",
|
|
114
|
+
* lastLogin: "January 20th 2024, 9:15:30 am",
|
|
115
|
+
* statusText: "Active",
|
|
116
|
+
* suspend: false,
|
|
117
|
+
* type: "mobile"
|
|
118
|
+
* },
|
|
119
|
+
* {
|
|
120
|
+
* appId: "e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7",
|
|
121
|
+
* created: "December 10th 2023, 11:45:20 am",
|
|
122
|
+
* lastLogin: "January 18th 2024, 4:20:15 pm",
|
|
123
|
+
* statusText: "Suspended",
|
|
124
|
+
* suspend: true,
|
|
125
|
+
* type: "desktop"
|
|
126
|
+
* }
|
|
127
|
+
* ]
|
|
128
|
+
* }
|
|
129
|
+
* *\/
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
132
|
+
* @example Retrieving subsequent page of devices
|
|
133
|
+
* ```javascript
|
|
134
|
+
* //
|
|
135
|
+
* const input = {
|
|
136
|
+
* maxResults: 10,
|
|
137
|
+
* networkId: "12345678",
|
|
138
|
+
* nextToken: "v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8",
|
|
139
|
+
* userId: "12345"
|
|
140
|
+
* };
|
|
141
|
+
* const command = new ListDevicesForUserCommand(input);
|
|
142
|
+
* const response = await client.send(command);
|
|
143
|
+
* /* response is
|
|
144
|
+
* {
|
|
145
|
+
* devices: [
|
|
146
|
+
* {
|
|
147
|
+
* appId: "f5357c64fde8659002c38e5db1804gf86g8044995ef8d187f47hdb141e01dce8",
|
|
148
|
+
* created: "January 1st 2024, 12:00:00 pm",
|
|
149
|
+
* lastLogin: "January 21st 2024, 8:22:00 am",
|
|
150
|
+
* statusText: "Active",
|
|
151
|
+
* suspend: false,
|
|
152
|
+
* type: "web"
|
|
153
|
+
* },
|
|
154
|
+
* {
|
|
155
|
+
* appId: "g6468d75gef9760113d49f6ec2915hg97h9155aa6fg9e298g58iec252f12edf9",
|
|
156
|
+
* created: "December 24th 2023, 4:00:00 pm",
|
|
157
|
+
* lastLogin: "January 20th 2024, 9:15:30 am",
|
|
158
|
+
* statusText: "Active",
|
|
159
|
+
* suspend: false,
|
|
160
|
+
* type: "mobile"
|
|
161
|
+
* }
|
|
162
|
+
* ],
|
|
163
|
+
* nextToken: "v1:pagination:7cb8c921-aebe-22e2-91c5-11d05fe541d9"
|
|
164
|
+
* }
|
|
165
|
+
* *\/
|
|
166
|
+
* ```
|
|
167
|
+
*
|
|
168
|
+
* @example Invalid userId error
|
|
169
|
+
* ```javascript
|
|
170
|
+
* //
|
|
171
|
+
* const input = {
|
|
172
|
+
* maxResults: 10,
|
|
173
|
+
* networkId: "12345678",
|
|
174
|
+
* userId: "99999"
|
|
175
|
+
* };
|
|
176
|
+
* const command = new ListDevicesForUserCommand(input);
|
|
177
|
+
* const response = await client.send(command);
|
|
178
|
+
* /* response is
|
|
179
|
+
* { /* metadata only *\/ }
|
|
180
|
+
* *\/
|
|
181
|
+
* ```
|
|
182
|
+
*
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export declare class ListDevicesForUserCommand extends ListDevicesForUserCommand_base {
|
|
186
|
+
/** @internal type navigation helper, not in runtime. */
|
|
187
|
+
protected static __types: {
|
|
188
|
+
api: {
|
|
189
|
+
input: ListDevicesForUserRequest;
|
|
190
|
+
output: ListDevicesForUserResponse;
|
|
191
|
+
};
|
|
192
|
+
sdk: {
|
|
193
|
+
input: ListDevicesForUserCommandInput;
|
|
194
|
+
output: ListDevicesForUserCommandOutput;
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
}
|