@aws-sdk/client-wickr 3.956.0

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

@@ -0,0 +1,229 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateUserRequest, UpdateUserResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateUserCommand}.
+ */
+export interface UpdateUserCommandInput extends UpdateUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateUserCommand}.
+ */
+export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataBearer {
+}
+declare const UpdateUserCommand_base: {
+    new (input: UpdateUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the properties of an existing user in a Wickr network. This operation allows you to modify the user's name, password, security group membership, and invite code settings.</p> <note> <p> <code>codeValidation</code>, <code>inviteCode</code>, and <code>inviteCodeTtl</code> are restricted to networks under preview only.</p> </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, UpdateUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, UpdateUserCommand } = 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 = { // UpdateUserRequest
+ *   networkId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE", // required
+ *   userDetails: { // UpdateUserDetails
+ *     firstName: "STRING_VALUE",
+ *     lastName: "STRING_VALUE",
+ *     username: "STRING_VALUE",
+ *     securityGroupIds: [ // SecurityGroupIdList
+ *       "STRING_VALUE",
+ *     ],
+ *     inviteCode: "STRING_VALUE",
+ *     inviteCodeTtl: Number("int"),
+ *     codeValidation: true || false,
+ *   },
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateUserResponse
+ * //   userId: "STRING_VALUE", // required
+ * //   networkId: "STRING_VALUE", // required
+ * //   securityGroupIds: [ // SecurityGroupIdList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   firstName: "STRING_VALUE",
+ * //   lastName: "STRING_VALUE",
+ * //   middleName: "STRING_VALUE",
+ * //   suspended: true || false, // required
+ * //   modified: Number("int"),
+ * //   status: Number("int"),
+ * //   inviteCode: "STRING_VALUE",
+ * //   inviteExpiration: Number("int"),
+ * //   codeValidation: true || false,
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
+ * @see {@link UpdateUserCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserCommandOutput} 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 Update user information
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userDetails: {
+ *     firstName: "Jonathan",
+ *     lastName: "Doe",
+ *     securityGroupIds: [
+ *       "BCTY8Qhe",
+ *       "DEPT001"
+ *     ],
+ *     username: "john.doe@example.com"
+ *   },
+ *   userId: "12345"
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   firstName: "Jonathan",
+ *   lastName: "Doe",
+ *   modified: 1705500000,
+ *   networkId: "12345678",
+ *   securityGroupIds: [
+ *     "BCTY8Qhe",
+ *     "DEPT001"
+ *   ],
+ *   status: 2,
+ *   suspended: false,
+ *   userId: "12345"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Update user with invite code
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userDetails: {
+ *     codeValidation: true,
+ *     firstName: "Jane",
+ *     inviteCode: "NEWINVITE789",
+ *     inviteCodeTtl: 14,
+ *     lastName: "Smith",
+ *     username: "jane.smith@example.com"
+ *   },
+ *   userId: "12345"
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   codeValidation: true,
+ *   firstName: "Jane",
+ *   inviteCode: "NEWINVITE789",
+ *   inviteExpiration: 1706709600,
+ *   lastName: "Smith",
+ *   modified: 1705500100,
+ *   networkId: "12345678",
+ *   status: 2,
+ *   suspended: false,
+ *   userId: "12345"
+ * }
+ * *\/
+ * ```
+ *
+ * @example User not found error
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userDetails: {
+ *     firstName: "Non",
+ *     lastName: "Existent",
+ *     username: "nonexistent@example.com"
+ *   },
+ *   userId: "99999"
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @example Invalid userId error
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userDetails: {
+ *     firstName: "John",
+ *     lastName: "Doe",
+ *     securityGroupIds: [
+ *       "BCTY8Qhe"
+ *     ],
+ *     username: "john.doe@example.com"
+ *   },
+ *   userId: "99999"
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateUserCommand extends UpdateUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateUserRequest;
+            output: UpdateUserResponse;
+        };
+        sdk: {
+            input: UpdateUserCommandInput;
+            output: UpdateUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,42 @@
+export * from "./BatchCreateUserCommand";
+export * from "./BatchDeleteUserCommand";
+export * from "./BatchLookupUserUnameCommand";
+export * from "./BatchReinviteUserCommand";
+export * from "./BatchResetDevicesForUserCommand";
+export * from "./BatchToggleUserSuspendStatusCommand";
+export * from "./CreateBotCommand";
+export * from "./CreateDataRetentionBotChallengeCommand";
+export * from "./CreateDataRetentionBotCommand";
+export * from "./CreateNetworkCommand";
+export * from "./CreateSecurityGroupCommand";
+export * from "./DeleteBotCommand";
+export * from "./DeleteDataRetentionBotCommand";
+export * from "./DeleteNetworkCommand";
+export * from "./DeleteSecurityGroupCommand";
+export * from "./GetBotCommand";
+export * from "./GetBotsCountCommand";
+export * from "./GetDataRetentionBotCommand";
+export * from "./GetGuestUserHistoryCountCommand";
+export * from "./GetNetworkCommand";
+export * from "./GetNetworkSettingsCommand";
+export * from "./GetOidcInfoCommand";
+export * from "./GetSecurityGroupCommand";
+export * from "./GetUserCommand";
+export * from "./GetUsersCountCommand";
+export * from "./ListBlockedGuestUsersCommand";
+export * from "./ListBotsCommand";
+export * from "./ListDevicesForUserCommand";
+export * from "./ListGuestUsersCommand";
+export * from "./ListNetworksCommand";
+export * from "./ListSecurityGroupUsersCommand";
+export * from "./ListSecurityGroupsCommand";
+export * from "./ListUsersCommand";
+export * from "./RegisterOidcConfigCommand";
+export * from "./RegisterOidcConfigTestCommand";
+export * from "./UpdateBotCommand";
+export * from "./UpdateDataRetentionCommand";
+export * from "./UpdateGuestUserCommand";
+export * from "./UpdateNetworkCommand";
+export * from "./UpdateNetworkSettingsCommand";
+export * from "./UpdateSecurityGroupCommand";
+export * from "./UpdateUserCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,50 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | undefined | Provider<string | undefined>;
+    useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string | undefined;
+    UseDualStack?: boolean | undefined;
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface WickrExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * <p>Welcome to the <i>Amazon Web Services Wickr API Reference</i>.</p> <p>The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr. </p> <p> <i>Using Amazon Web Services SDK</i> </p> <p>The SDK clients authenticate your requests by using access keys that you provide. For more information, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/access.html">Authentication and access using Amazon Web Services SDKs and tools</a> in the <i>Amazon Web Services SDKs and Tools Reference Guide</i>. </p> <p> <i>Using Amazon Web Services CLI</i> </p> <p>Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html">Getting started with the Amazon Web Services CLI</a> in the <i>Amazon Web Services Command Line Interface User Guide for Version 2</i>. </p> <p> <i>Using REST APIs</i> </p> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html">Amazon Web Services Signature Version 4 for API requests</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>. </p> <p>Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AWSWickrFullAccess">Amazon Web ServicesWickrFullAccess</a> grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see <a href="https://docs.aws.amazon.com/wickr/latest/adminguide/security-iam.html">Identity and access management for Amazon Web Services Wickr </a> in the <i>Amazon Web Services Wickr Administration Guide</i>. </p> <p> <i>Types of Errors</i>:</p> <p>The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.</p> <ol> <li> <p>Client errors are indicated by HTTP Status Code class of 4xx</p> </li> <li> <p>Service errors are indicated by HTTP Status Code class of 5xx</p> </li> </ol> <p>In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./WickrClient";
+export * from "./Wickr";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { WickrExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { WickrServiceException } from "./models/WickrServiceException";

package/dist-types/models/WickrServiceException.d.ts

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from Wickr service.
+ */
+export declare class WickrServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/enums.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const AccessLevel: {
+    readonly PREMIUM: "PREMIUM";
+    readonly STANDARD: "STANDARD";
+};
+/**
+ * @public
+ */
+export type AccessLevel = (typeof AccessLevel)[keyof typeof AccessLevel];
+export declare enum BotStatus {
+    PENDING = 1,
+    ACTIVE = 2
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DataRetentionActionType: {
+    readonly DISABLE: "DISABLE";
+    readonly ENABLE: "ENABLE";
+    readonly PUBKEY_MSG_ACK: "PUBKEY_MSG_ACK";
+};
+/**
+ * @public
+ */
+export type DataRetentionActionType = (typeof DataRetentionActionType)[keyof typeof DataRetentionActionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SortDirection: {
+    readonly ASC: "ASC";
+    readonly DESC: "DESC";
+};
+/**
+ * @public
+ */
+export type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];
+export declare enum UserStatus {
+    PENDING = 1,
+    ACTIVE = 2
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const Status: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+    readonly FORCE_ENABLED: "FORCE_ENABLED";
+};
+/**
+ * @public
+ */
+export type Status = (typeof Status)[keyof typeof Status];

package/dist-types/models/errors.d.ts

@@ -0,0 +1,92 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ErrorDetail } from "./models_0";
+import { WickrServiceException as __BaseException } from "./WickrServiceException";
+/**
+ * <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>
+ * @public
+ */
+export declare class BadRequestError extends __BaseException {
+    readonly name: "BadRequestError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<BadRequestError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class ForbiddenError extends __BaseException {
+    readonly name: "ForbiddenError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class InternalServerError extends __BaseException {
+    readonly name: "InternalServerError";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class RateLimitError extends __BaseException {
+    readonly name: "RateLimitError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<RateLimitError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class ResourceNotFoundError extends __BaseException {
+    readonly name: "ResourceNotFoundError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class UnauthorizedError extends __BaseException {
+    readonly name: "UnauthorizedError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedError, __BaseException>);
+}
+/**
+ * <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>
+ * @public
+ */
+export declare class ValidationError extends __BaseException {
+    readonly name: "ValidationError";
+    readonly $fault: "client";
+    /**
+     * <p>A list of validation error details, where each item identifies a specific field that failed validation and explains the reason for the failure.</p>
+     * @public
+     */
+    reasons?: ErrorDetail[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationError, __BaseException>);
+}