@aws-sdk/client-wickr 3.956.0

package/dist-types/commands/ListGuestUsersCommand.d.ts

@@ -0,0 +1,192 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListGuestUsersRequest, ListGuestUsersResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListGuestUsersCommand}.
+ */
+export interface ListGuestUsersCommandInput extends ListGuestUsersRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListGuestUsersCommand}.
+ */
+export interface ListGuestUsersCommandOutput extends ListGuestUsersResponse, __MetadataBearer {
+}
+declare const ListGuestUsersCommand_base: {
+    new (input: ListGuestUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListGuestUsersCommandInput, ListGuestUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListGuestUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListGuestUsersCommandInput, ListGuestUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, ListGuestUsersCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, ListGuestUsersCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // ListGuestUsersRequest
+ *   networkId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   sortDirection: "ASC" || "DESC",
+ *   sortFields: "STRING_VALUE",
+ *   username: "STRING_VALUE",
+ *   billingPeriod: "STRING_VALUE",
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListGuestUsersCommand(input);
+ * const response = await client.send(command);
+ * // { // ListGuestUsersResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   guestlist: [ // GuestUserList // required
+ * //     { // GuestUser
+ * //       billingPeriod: "STRING_VALUE", // required
+ * //       username: "STRING_VALUE", // required
+ * //       usernameHash: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListGuestUsersCommandInput - {@link ListGuestUsersCommandInput}
+ * @returns {@link ListGuestUsersCommandOutput}
+ * @see {@link ListGuestUsersCommandInput} for command's `input` shape.
+ * @see {@link ListGuestUsersCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <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>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <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>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ResourceNotFoundError} (client fault)
+ *  <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>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <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>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example Get paginated list of guest users
+ * ```javascript
+ * //
+ * const input = {
+ *   maxResults: 20,
+ *   networkId: "12345678",
+ *   sortDirection: "DESC",
+ *   sortFields: "billingPeriod"
+ * };
+ * const command = new ListGuestUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   guestlist: [
+ *     {
+ *       billingPeriod: "2024-01",
+ *       username: "guest1@example.com",
+ *       usernameHash: "e8e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     },
+ *     {
+ *       billingPeriod: "2024-01",
+ *       username: "guest2@example.com",
+ *       usernameHash: "a9e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     },
+ *     {
+ *       billingPeriod: "2023-12",
+ *       username: "guest3@example.com",
+ *       usernameHash: "c3e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     },
+ *     {
+ *       billingPeriod: "2023-12",
+ *       username: "guest4@example.com",
+ *       usernameHash: "k2e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     }
+ *   ],
+ *   nextToken: "v1:pagination:550e8400-e29b-41d4-a716-446655440000"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Filter by billing period
+ * ```javascript
+ * //
+ * const input = {
+ *   billingPeriod: "2024-01",
+ *   maxResults: 10,
+ *   networkId: "12345678"
+ * };
+ * const command = new ListGuestUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   guestlist: [
+ *     {
+ *       billingPeriod: "2024-01",
+ *       username: "guest1@example.com",
+ *       usernameHash: "e8e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     },
+ *     {
+ *       billingPeriod: "2024-01",
+ *       username: "guest2@example.com",
+ *       usernameHash: "a9e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26"
+ *     }
+ *   ],
+ *   nextToken: "v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Empty guest list
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "87654321"
+ * };
+ * const command = new ListGuestUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   guestlist:   []
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListGuestUsersCommand extends ListGuestUsersCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListGuestUsersRequest;
+            output: ListGuestUsersResponse;
+        };
+        sdk: {
+            input: ListGuestUsersCommandInput;
+            output: ListGuestUsersCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListNetworksCommand.d.ts

@@ -0,0 +1,167 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListNetworksRequest, ListNetworksResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListNetworksCommand}.
+ */
+export interface ListNetworksCommandInput extends ListNetworksRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListNetworksCommand}.
+ */
+export interface ListNetworksCommandOutput extends ListNetworksResponse, __MetadataBearer {
+}
+declare const ListNetworksCommand_base: {
+    new (input: ListNetworksCommandInput): import("@smithy/smithy-client").CommandImpl<ListNetworksCommandInput, ListNetworksCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListNetworksCommandInput]): import("@smithy/smithy-client").CommandImpl<ListNetworksCommandInput, ListNetworksCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, ListNetworksCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, ListNetworksCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // ListNetworksRequest
+ *   maxResults: Number("int"),
+ *   sortFields: "STRING_VALUE",
+ *   sortDirection: "ASC" || "DESC",
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListNetworksCommand(input);
+ * const response = await client.send(command);
+ * // { // ListNetworksResponse
+ * //   networks: [ // NetworkList // required
+ * //     { // Network
+ * //       networkId: "STRING_VALUE", // required
+ * //       networkName: "STRING_VALUE", // required
+ * //       accessLevel: "STANDARD" || "PREMIUM", // required
+ * //       awsAccountId: "STRING_VALUE", // required
+ * //       networkArn: "STRING_VALUE", // required
+ * //       standing: Number("int"),
+ * //       freeTrialExpiration: "STRING_VALUE",
+ * //       migrationState: Number("int"),
+ * //       encryptionKeyArn: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListNetworksCommandInput - {@link ListNetworksCommandInput}
+ * @returns {@link ListNetworksCommandOutput}
+ * @see {@link ListNetworksCommandInput} for command's `input` shape.
+ * @see {@link ListNetworksCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <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>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <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>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <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>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <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>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example List networks with pagination
+ * ```javascript
+ * //
+ * const input = {
+ *   maxResults: 10,
+ *   sortDirection: "ASC",
+ *   sortFields: "networkName"
+ * };
+ * const command = new ListNetworksCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   networks: [
+ *     {
+ *       accessLevel: "STANDARD",
+ *       awsAccountId: "123456789012",
+ *       networkArn: "arn:aws:wickr:us-east-1:123456789012:network/12345678",
+ *       networkId: "12345678",
+ *       networkName: "Dev Network",
+ *       standing: 1
+ *     },
+ *     {
+ *       accessLevel: "PREMIUM",
+ *       awsAccountId: "123456789012",
+ *       networkArn: "arn:aws:wickr:us-east-1:123456789012:network/87654321",
+ *       networkId: "87654321",
+ *       networkName: "Prod Network",
+ *       standing: 1
+ *     }
+ *   ],
+ *   nextToken: "eyJvZmZzZXQiOjEwfQ=="
+ * }
+ * *\/
+ * ```
+ *
+ * @example List networks - first page
+ * ```javascript
+ * //
+ * const input = {
+ *   maxResults: 10
+ * };
+ * const command = new ListNetworksCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   networks: [
+ *     {
+ *       accessLevel: "PREMIUM",
+ *       awsAccountId: "123456789012",
+ *       networkArn: "arn:aws:wickr:us-east-1:123456789012:network/12345678",
+ *       networkId: "12345678",
+ *       networkName: "Production Network",
+ *       standing: 1
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListNetworksCommand extends ListNetworksCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListNetworksRequest;
+            output: ListNetworksResponse;
+        };
+        sdk: {
+            input: ListNetworksCommandInput;
+            output: ListNetworksCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListSecurityGroupUsersCommand.d.ts

@@ -0,0 +1,156 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListSecurityGroupUsersRequest, ListSecurityGroupUsersResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListSecurityGroupUsersCommand}.
+ */
+export interface ListSecurityGroupUsersCommandInput extends ListSecurityGroupUsersRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListSecurityGroupUsersCommand}.
+ */
+export interface ListSecurityGroupUsersCommandOutput extends ListSecurityGroupUsersResponse, __MetadataBearer {
+}
+declare const ListSecurityGroupUsersCommand_base: {
+    new (input: ListSecurityGroupUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecurityGroupUsersCommandInput, ListSecurityGroupUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListSecurityGroupUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecurityGroupUsersCommandInput, ListSecurityGroupUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of users who belong to a specific security group in a Wickr network.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, ListSecurityGroupUsersCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, ListSecurityGroupUsersCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // ListSecurityGroupUsersRequest
+ *   networkId: "STRING_VALUE", // required
+ *   groupId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   sortFields: "STRING_VALUE",
+ *   sortDirection: "ASC" || "DESC",
+ * };
+ * const command = new ListSecurityGroupUsersCommand(input);
+ * const response = await client.send(command);
+ * // { // ListSecurityGroupUsersResponse
+ * //   users: [ // Users // required
+ * //     { // User
+ * //       userId: "STRING_VALUE",
+ * //       firstName: "STRING_VALUE",
+ * //       lastName: "STRING_VALUE",
+ * //       username: "STRING_VALUE",
+ * //       securityGroups: [ // SecurityGroupIdList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       isAdmin: true || false,
+ * //       suspended: true || false,
+ * //       status: Number("int"),
+ * //       otpEnabled: true || false,
+ * //       scimId: "STRING_VALUE",
+ * //       type: "STRING_VALUE",
+ * //       cell: "STRING_VALUE",
+ * //       countryCode: "STRING_VALUE",
+ * //       challengeFailures: Number("int"),
+ * //       isInviteExpired: true || false,
+ * //       isUser: true || false,
+ * //       inviteCode: "STRING_VALUE",
+ * //       codeValidation: true || false,
+ * //       uname: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListSecurityGroupUsersCommandInput - {@link ListSecurityGroupUsersCommandInput}
+ * @returns {@link ListSecurityGroupUsersCommandOutput}
+ * @see {@link ListSecurityGroupUsersCommandInput} for command's `input` shape.
+ * @see {@link ListSecurityGroupUsersCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <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>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <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>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ResourceNotFoundError} (client fault)
+ *  <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>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <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>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <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>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example List security group users with pagination
+ * ```javascript
+ * //
+ * const input = {
+ *   groupId: "abc12345",
+ *   maxResults: 10,
+ *   networkId: "12345678",
+ *   sortDirection: "ASC",
+ *   sortFields: "username"
+ * };
+ * const command = new ListSecurityGroupUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   nextToken: "eyJvZmZzZXQiOjEwfQ==",
+ *   users: [
+ *     {
+ *       firstName: "Alice",
+ *       lastName: "Smith",
+ *       username: "alice@example.com"
+ *     },
+ *     {
+ *       firstName: "Bob",
+ *       lastName: "Jones",
+ *       username: "bob@example.com"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListSecurityGroupUsersCommand extends ListSecurityGroupUsersCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListSecurityGroupUsersRequest;
+            output: ListSecurityGroupUsersResponse;
+        };
+        sdk: {
+            input: ListSecurityGroupUsersCommandInput;
+            output: ListSecurityGroupUsersCommandOutput;
+        };
+    };
+}