Package-level declarations

Types

Link copied to clipboard

Welcome to the Amazon Web Services Wickr API Reference.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun WickrClient.createBot(crossinline block: CreateBotRequest.Builder.() -> Unit): CreateBotResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.deleteBot(crossinline block: DeleteBotRequest.Builder.() -> Unit): DeleteBotResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.getBot(crossinline block: GetBotRequest.Builder.() -> Unit): GetBotResponse

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

Link copied to clipboard
inline suspend fun WickrClient.getBotsCount(crossinline block: GetBotsCountRequest.Builder.() -> Unit): GetBotsCountResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.getNetwork(crossinline block: GetNetworkRequest.Builder.() -> Unit): GetNetworkResponse

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.getOidcInfo(crossinline block: GetOidcInfoRequest.Builder.() -> Unit): GetOidcInfoResponse

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.getUser(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.listBots(crossinline block: ListBotsRequest.Builder.() -> Unit): ListBotsResponse

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun WickrClient.listNetworks(crossinline block: ListNetworksRequest.Builder.() -> Unit): ListNetworksResponse

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.updateBot(crossinline block: UpdateBotRequest.Builder.() -> Unit): UpdateBotResponse

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun WickrClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.