Module Awso_wickr.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule GenericString : sig ... end
Sourcemodule NetworkId : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule Integer : sig ... end

Identifies a Wickr enterprise network that is permitted for global federation, allowing users to communicate with members of the specified network.

Sourcemodule WickrAwsNetworks : sig ... end

Identifies a Amazon Web Services Wickr network by region and network ID, used for configuring permitted networks for global federation.

Sourcemodule SecurityGroupId : sig ... end
Sourcemodule CallingSettings : sig ... end

Defines the calling feature permissions and settings for users in a security group, controlling what types of calls users can initiate and participate in.

Sourcemodule Long : sig ... end
Sourcemodule PasswordRequirements : sig ... end

Defines password complexity requirements for users in a security group, including minimum length and character type requirements.

Sourcemodule PermittedNetworksList : sig ... end
Sourcemodule SecurityGroupStringList : sig ... end
Sourcemodule ShredderSettings : sig ... end

Configuration for the message shredder feature, which securely deletes messages and files from devices to prevent data recovery.

Sourcemodule WickrAwsNetworksList : sig ... end
Sourcemodule ErrorDetail : sig ... end

Contains detailed error information explaining why an operation failed, including which field caused the error and the reason for the failure.

Sourcemodule Status : sig ... end
Sourcemodule SecurityGroupIdList : sig ... end
Sourcemodule SensitiveString : sig ... end
Sourcemodule UserId : sig ... end
Sourcemodule SecurityGroupSettings : sig ... end

Comprehensive configuration settings that define all user capabilities, restrictions, and features for members of a security group. These settings control everything from calling permissions to federation settings to security policies.

Sourcemodule AccessLevel : sig ... end
Sourcemodule BotStatus : sig ... end
Sourcemodule Uname : sig ... end
Sourcemodule ErrorDetailList : sig ... end
Sourcemodule Setting : sig ... end

Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.

Sourcemodule ReadReceiptConfig : sig ... end

Configuration for read receipts at the network level, controlling whether senders can see when their messages have been read.

Sourcemodule User : sig ... end

Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details. codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

Sourcemodule SecurityGroup : sig ... end

Represents a security group in a Wickr network, containing membership statistics, configuration, and all permission settings that apply to its members.

Sourcemodule Network : sig ... end

Represents a Wickr network with all its configuration and status information.

Sourcemodule GuestUser : sig ... end

Represents a guest user who has accessed the network from a federated Wickr network.

Sourcemodule BasicDeviceObject : sig ... end

Represents a device where a user has logged into Wickr, containing information about the device's type, status, and login history.

Sourcemodule Bot : sig ... end

Represents a bot account in a Wickr network with all its informational fields.

Sourcemodule BlockedGuestUser : sig ... end

Represents a guest user who has been blocked from accessing a Wickr network.

Sourcemodule GuestUserHistoryCount : sig ... end

Contains the count of guest users for a specific billing period, used for tracking historical guest user activity.

Contains error information for a user operation that failed in a batch user request.

Contains information about a user that was successfully processed in a batch user operation.

Contains error information for a device operation that failed in a batch device request.

Contains information about a device that was successfully processed in a batch device operation.

Contains error information for a username hash lookup that failed in a batch uname lookup request.

Contains information about a username hash that was successfully resolved in a batch uname lookup operation.

Contains the details for a single user to be created in a batch user creation request. A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

Sourcemodule BadRequestError : sig ... end

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.

Sourcemodule ForbiddenError : sig ... end

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.

Sourcemodule InternalServerError : sig ... end

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.

Sourcemodule RateLimitError : sig ... end

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.

Sourcemodule ResourceNotFoundError : sig ... end

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.

Sourcemodule UnauthorizedError : sig ... end

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.

Sourcemodule ValidationError : sig ... end

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.

Sourcemodule UpdateUserDetails : sig ... end

Contains the modifiable details for updating an existing user, including name, password, security group membership, and invitation settings. A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

Sourcemodule SettingsList : sig ... end
Sourcemodule NetworkSettings : sig ... end

Contains network-level configuration settings that apply to all users and security groups within a Wickr network.

Sourcemodule ClientToken : sig ... end
Sourcemodule DataRetentionActionType : sig ... end
Sourcemodule BotId : sig ... end
Sourcemodule StringList : sig ... end
Sourcemodule Users : sig ... end
Sourcemodule SortDirection : sig ... end
Sourcemodule UserStatus : sig ... end
Sourcemodule SecurityGroupList : sig ... end
Sourcemodule NetworkList : sig ... end
Sourcemodule GuestUserList : sig ... end
Sourcemodule Devices : sig ... end
Sourcemodule Bots : sig ... end
Sourcemodule BlockedGuestUserList : sig ... end
Sourcemodule OidcConfigInfo : sig ... end

Contains the OpenID Connect (OIDC) configuration information for Single Sign-On (SSO) authentication, including identity provider settings and client credentials.

Sourcemodule OidcTokenInfo : sig ... end

Contains OAuth token information returned from the identity provider, including access tokens, ID tokens, and PKCE parameters used for secure authentication.

Sourcemodule GuestUserHistoryCountList : sig ... end

Contains the security group configuration settings that can be specified when creating or updating a security group. This is a subset of SecurityGroupSettings containing only the modifiable federation and security settings.

Sourcemodule UserIds : sig ... end
Sourcemodule AppIds : sig ... end
Sourcemodule Unames : sig ... end
Sourcemodule UpdateUserResponse : sig ... end

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. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

Sourcemodule UpdateUserRequest : sig ... end

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. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

Updates the properties of an existing security group in a Wickr network, such as its name or settings.

Updates the properties of an existing security group in a Wickr network, such as its name or settings.

Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.

Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.

Sourcemodule UpdateNetworkResponse : sig ... end

Updates the properties of an existing Wickr network, such as its name or encryption key configuration.

Sourcemodule UpdateNetworkRequest : sig ... end

Updates the properties of an existing Wickr network, such as its name or encryption key configuration.

Sourcemodule UpdateGuestUserResponse : sig ... end

Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

Sourcemodule UpdateGuestUserRequest : sig ... end

Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.

Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.

Sourcemodule UpdateBotResponse : sig ... end

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

Sourcemodule UpdateBotRequest : sig ... end

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.

Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

Sourcemodule RegisterOidcConfigRequest : sig ... end

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

Sourcemodule ListUsersResponse : sig ... end

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

Sourcemodule ListUsersRequest : sig ... end

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.

Sourcemodule ListSecurityGroupsRequest : sig ... end

Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.

Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

Sourcemodule ListNetworksResponse : sig ... end

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.

Sourcemodule ListNetworksRequest : sig ... end

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.

Sourcemodule ListGuestUsersResponse : sig ... end

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.

Sourcemodule ListGuestUsersRequest : sig ... end

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.

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.

Sourcemodule ListDevicesForUserRequest : sig ... end

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.

Sourcemodule ListBotsResponse : sig ... end

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

Sourcemodule ListBotsRequest : sig ... end

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

Sourcemodule GetUsersCountResponse : sig ... end

Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.

Sourcemodule GetUsersCountRequest : sig ... end

Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.

Sourcemodule GetUserResponse : sig ... end

Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

Sourcemodule GetUserRequest : sig ... end

Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

Sourcemodule GetSecurityGroupResponse : sig ... end

Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.

Sourcemodule GetSecurityGroupRequest : sig ... end

Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.

Sourcemodule GetOpentdfConfigResponse : sig ... end

Retrieves the OpenTDF integration configuration for a Wickr network.

Sourcemodule GetOpentdfConfigRequest : sig ... end

Retrieves the OpenTDF integration configuration for a Wickr network.

Sourcemodule GetOidcInfoResponse : sig ... end

Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.

Sourcemodule GetOidcInfoRequest : sig ... end

Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.

Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.

Sourcemodule GetNetworkSettingsRequest : sig ... end

Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.

Sourcemodule GetNetworkResponse : sig ... end

Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.

Sourcemodule GetNetworkRequest : sig ... end

Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.

Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.

Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.

Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.

Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.

Sourcemodule GetBotsCountResponse : sig ... end

Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).

Sourcemodule GetBotsCountRequest : sig ... end

Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).

Sourcemodule GetBotResponse : sig ... end

Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.

Sourcemodule GetBotRequest : sig ... end

Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.

Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.

Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.

Sourcemodule DeleteNetworkResponse : sig ... end

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.

Sourcemodule DeleteNetworkRequest : sig ... end

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.

Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.

Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.

Sourcemodule DeleteBotResponse : sig ... end

Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.

Sourcemodule DeleteBotRequest : sig ... end

Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.

Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.

Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.

Sourcemodule CreateNetworkResponse : sig ... end

Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.

Sourcemodule CreateNetworkRequest : sig ... end

Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.

Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.

Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.

Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.

Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.

Sourcemodule CreateBotResponse : sig ... end

Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

Sourcemodule CreateBotRequest : sig ... end

Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.

Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.

Sourcemodule BatchReinviteUserResponse : sig ... end

Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.

Sourcemodule BatchReinviteUserRequest : sig ... end

Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.

Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.

Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.

Sourcemodule BatchDeleteUserResponse : sig ... end

Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.

Sourcemodule BatchDeleteUserRequest : sig ... end

Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.

Sourcemodule BatchCreateUserResponse : sig ... end

Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

Sourcemodule BatchCreateUserRequest : sig ... end

Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.