Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Wickr Admin API

Client for invoking operations on AWS Wickr Admin API. Each operation on AWS Wickr Admin API is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_wickr::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_wickr::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchCreateUser operation has a Client::batch_create_user, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_create_user()
    .network_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_create_user(&self) -> BatchCreateUserFluentBuilder

Constructs a fluent builder for the BatchCreateUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where users will be created.

    
    
  • users(BatchCreateUserRequestItem) / set_users(Option<Vec::<BatchCreateUserRequestItem>>):
    required: true
    

    A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.

    
    
• On success, responds with BatchCreateUserOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch operation.

  • successful(Option<Vec::<User>>):

    A list of user objects that were successfully created, including their assigned user IDs and invite codes.

  • failed(Option<Vec::<BatchUserErrorResponseItem>>):

    A list of user creation attempts that failed, including error details explaining why each user could not be created.

• On failure, responds with SdkError<BatchCreateUserError>

impl Client

pub fn batch_delete_user(&self) -> BatchDeleteUserFluentBuilder

Constructs a fluent builder for the BatchDeleteUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which users will be deleted.

    
    
  • user_ids(impl Into<String>) / set_user_ids(Option<Vec::<String>>):
    required: true
    

    A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete users again.

    
    
• On success, responds with BatchDeleteUserOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch deletion operation.

  • successful(Option<Vec::<BatchUserSuccessResponseItem>>):

    A list of user IDs that were successfully deleted from the network.

  • failed(Option<Vec::<BatchUserErrorResponseItem>>):

    A list of user deletion attempts that failed, including error details explaining why each user could not be deleted.

• On failure, responds with SdkError<BatchDeleteUserError>

impl Client

pub fn batch_lookup_user_uname(&self) -> BatchLookupUserUnameFluentBuilder

Constructs a fluent builder for the BatchLookupUserUname operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where the users will be looked up.

    
    
  • unames(impl Into<String>) / set_unames(Option<Vec::<String>>):
    required: true
    

    A list of username hashes (unames) to look up. Each uname is a unique identifier for a user’s username. Maximum 50 unames per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
• On success, responds with BatchLookupUserUnameOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch lookup operation.

  • successful(Option<Vec::<BatchUnameSuccessResponseItem>>):

    A list of successfully resolved username hashes with their corresponding email addresses.

  • failed(Option<Vec::<BatchUnameErrorResponseItem>>):

    A list of username hash lookup attempts that failed, including error details explaining why each lookup failed.

• On failure, responds with SdkError<BatchLookupUserUnameError>

impl Client

pub fn batch_reinvite_user(&self) -> BatchReinviteUserFluentBuilder

Constructs a fluent builder for the BatchReinviteUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where users will be reinvited.

    
    
  • user_ids(impl Into<String>) / set_user_ids(Option<Vec::<String>>):
    required: true
    

    A list of user IDs identifying the users to be reinvited to the network. Maximum 50 users per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
• On success, responds with BatchReinviteUserOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch reinvitation operation.

  • successful(Option<Vec::<BatchUserSuccessResponseItem>>):

    A list of user IDs that were successfully reinvited.

  • failed(Option<Vec::<BatchUserErrorResponseItem>>):

    A list of reinvitation attempts that failed, including error details explaining why each user could not be reinvited.

• On failure, responds with SdkError<BatchReinviteUserError>

impl Client

pub fn batch_reset_devices_for_user( &self, ) -> BatchResetDevicesForUserFluentBuilder

Constructs a fluent builder for the BatchResetDevicesForUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the user whose devices will be reset.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The ID of the user whose devices will be reset.

    
    
  • app_ids(impl Into<String>) / set_app_ids(Option<Vec::<String>>):
    required: true
    

    A list of application IDs identifying the specific devices to be reset for the user. Maximum 50 devices per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
• On success, responds with BatchResetDevicesForUserOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch device reset operation.

  • successful(Option<Vec::<BatchDeviceSuccessResponseItem>>):

    A list of application IDs that were successfully reset.

  • failed(Option<Vec::<BatchDeviceErrorResponseItem>>):

    A list of device reset attempts that failed, including error details explaining why each device could not be reset.

• On failure, responds with SdkError<BatchResetDevicesForUserError>

impl Client

pub fn batch_toggle_user_suspend_status( &self, ) -> BatchToggleUserSuspendStatusFluentBuilder

Constructs a fluent builder for the BatchToggleUserSuspendStatus operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where users will be suspended or unsuspended.

    
    
  • suspend(bool) / set_suspend(Option<bool>):
    required: true
    

    A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.

    
    
  • user_ids(impl Into<String>) / set_user_ids(Option<Vec::<String>>):
    required: true
    

    A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
• On success, responds with BatchToggleUserSuspendStatusOutput with field(s):
  • message(Option<String>):

    A message indicating the overall result of the batch suspend status toggle operation.

  • successful(Option<Vec::<BatchUserSuccessResponseItem>>):

    A list of user IDs whose suspend status was successfully toggled.

  • failed(Option<Vec::<BatchUserErrorResponseItem>>):

    A list of suspend status toggle attempts that failed, including error details explaining why each user’s status could not be changed.

• On failure, responds with SdkError<BatchToggleUserSuspendStatusError>

impl Client

pub fn create_bot(&self) -> CreateBotFluentBuilder

Constructs a fluent builder for the CreateBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where the bot will be created.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: true
    

    The username for the bot. This must be unique within the network and follow the network’s naming conventions.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name for the bot that will be visible to users in the network.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The ID of the security group to which the bot will be assigned.

    
    
  • challenge(impl Into<String>) / set_challenge(Option<String>):
    required: true
    

    The password for the bot account.

    
    
• On success, responds with CreateBotOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the bot creation operation.

  • bot_id(String):

    The unique identifier assigned to the newly created bot.

  • network_id(Option<String>):

    The ID of the network where the bot was created.

  • username(Option<String>):

    The username of the newly created bot.

  • display_name(Option<String>):

    The display name of the newly created bot.

  • group_id(Option<String>):

    The ID of the security group to which the bot was assigned.

• On failure, responds with SdkError<CreateBotError>

impl Client

pub fn create_data_retention_bot(&self) -> CreateDataRetentionBotFluentBuilder

Constructs a fluent builder for the CreateDataRetentionBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where the data retention bot will be created.

    
    
• On success, responds with CreateDataRetentionBotOutput with field(s):
  • message(Option<String>):

    A message indicating that the data retention bot was successfully provisioned.

• On failure, responds with SdkError<CreateDataRetentionBotError>

impl Client

pub fn create_data_retention_bot_challenge( &self, ) -> CreateDataRetentionBotChallengeFluentBuilder

Constructs a fluent builder for the CreateDataRetentionBotChallenge operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the data retention bot.

    
    
• On success, responds with CreateDataRetentionBotChallengeOutput with field(s):
  • challenge(String):

    The newly generated challenge password for the data retention bot.

• On failure, responds with SdkError<CreateDataRetentionBotChallengeError>

impl Client

pub fn create_network(&self) -> CreateNetworkFluentBuilder

Constructs a fluent builder for the CreateNetwork operation.

• The fluent builder is configurable:
  • network_name(impl Into<String>) / set_network_name(Option<String>):
    required: true
    

    The name for the new network. Must be between 1 and 20 characters.

    
    
  • access_level(AccessLevel) / set_access_level(Option<AccessLevel>):
    required: true
    

    The access level for the network. Valid values are STANDARD or PREMIUM, which determine the features and capabilities available to network members.

    
    
  • enable_premium_free_trial(bool) / set_enable_premium_free_trial(Option<bool>):
    required: false
    

    Specifies whether to enable a premium free trial for the network. It is optional and has a default value as false. When set to true, the network starts with premium features for a limited trial period.

    
    
  • encryption_key_arn(impl Into<String>) / set_encryption_key_arn(Option<String>):
    required: false
    

    The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.

    
    
• On success, responds with CreateNetworkOutput with field(s):
  • network_id(Option<String>):

    The unique identifier assigned to the newly created network.

  • network_name(Option<String>):

    The name of the newly created network.

  • encryption_key_arn(Option<String>):

    The ARN of the KMS key being used to encrypt sensitive data in the network.

• On failure, responds with SdkError<CreateNetworkError>

impl Client

pub fn create_security_group(&self) -> CreateSecurityGroupFluentBuilder

Constructs a fluent builder for the CreateSecurityGroup operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where the security group will be created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the new security group.

    
    
  • security_group_settings(SecurityGroupSettingsRequest) / set_security_group_settings(Option<SecurityGroupSettingsRequest>):
    required: true
    

    The configuration settings for the security group, including permissions, federation settings, and feature controls.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
• On success, responds with CreateSecurityGroupOutput with field(s):
  • security_group(Option<SecurityGroup>):

    The details of the newly created security group, including its ID, name, and settings.

• On failure, responds with SdkError<CreateSecurityGroupError>

impl Client

pub fn delete_bot(&self) -> DeleteBotFluentBuilder

Constructs a fluent builder for the DeleteBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which the bot will be deleted.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot to be deleted.

    
    
• On success, responds with DeleteBotOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the bot deletion operation.

• On failure, responds with SdkError<DeleteBotError>

impl Client

pub fn delete_data_retention_bot(&self) -> DeleteDataRetentionBotFluentBuilder

Constructs a fluent builder for the DeleteDataRetentionBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which the data retention bot will be deleted.

    
    
• On success, responds with DeleteDataRetentionBotOutput with field(s):
  • message(Option<String>):

    A message indicating that the data retention bot and all associated data were successfully deleted.

• On failure, responds with SdkError<DeleteDataRetentionBotError>

impl Client

pub fn delete_network(&self) -> DeleteNetworkFluentBuilder

Constructs a fluent builder for the DeleteNetwork operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete the network again.

    
    
• On success, responds with DeleteNetworkOutput with field(s):
  • message(Option<String>):

    A message indicating that the network deletion has been initiated successfully.

• On failure, responds with SdkError<DeleteNetworkError>

impl Client

pub fn delete_security_group(&self) -> DeleteSecurityGroupFluentBuilder

Constructs a fluent builder for the DeleteSecurityGroup operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which the security group will be deleted.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The unique identifier of the security group to delete.

    
    
• On success, responds with DeleteSecurityGroupOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the security group deletion operation.

  • network_id(Option<String>):

    The ID of the network from which the security group was deleted.

  • group_id(Option<String>):

    The ID of the security group that was deleted.

• On failure, responds with SdkError<DeleteSecurityGroupError>

impl Client

pub fn get_bot(&self) -> GetBotFluentBuilder

Constructs a fluent builder for the GetBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the bot.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot to retrieve.

    
    
• On success, responds with GetBotOutput with field(s):
  • bot_id(Option<String>):

    The unique identifier of the bot.

  • display_name(Option<String>):

    The display name of the bot that is visible to users.

  • username(Option<String>):

    The username of the bot.

  • uname(Option<String>):

    The unique username hash identifier for the bot.

  • pubkey(Option<String>):

    The public key of the bot used for encryption.

  • status(Option<i32>):

    The current status of the bot (1 for pending, 2 for active).

  • group_id(Option<String>):

    The ID of the security group to which the bot belongs.

  • has_challenge(Option<bool>):

    Indicates whether the bot has a password set.

  • suspended(Option<bool>):

    Indicates whether the bot is currently suspended.

  • last_login(Option<String>):

    The timestamp of the bot’s last login.

• On failure, responds with SdkError<GetBotError>

impl Client

pub fn get_bots_count(&self) -> GetBotsCountFluentBuilder

Constructs a fluent builder for the GetBotsCount operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network for which to retrieve bot counts.

    
    
• On success, responds with GetBotsCountOutput with field(s):
  • pending(i32):

    The number of bots with pending status (invited but not yet activated).

  • active(i32):

    The number of bots with active status.

  • total(i32):

    The total number of bots in the network (active and pending).

• On failure, responds with SdkError<GetBotsCountError>

impl Client

pub fn get_data_retention_bot(&self) -> GetDataRetentionBotFluentBuilder

Constructs a fluent builder for the GetDataRetentionBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the data retention bot.

    
    
• On success, responds with GetDataRetentionBotOutput with field(s):
  • bot_name(Option<String>):

    The name of the data retention bot.

  • bot_exists(Option<bool>):

    Indicates whether a data retention bot exists in the network.

  • is_bot_active(Option<bool>):

    Indicates whether the data retention bot is active and operational.

  • is_data_retention_bot_registered(Option<bool>):

    Indicates whether the data retention bot has been registered with the network.

  • is_data_retention_service_enabled(Option<bool>):

    Indicates whether the data retention service is enabled for the network.

  • is_pubkey_msg_acked(Option<bool>):

    Indicates whether the public key message has been acknowledged by the bot.

• On failure, responds with SdkError<GetDataRetentionBotError>

impl Client

pub fn get_guest_user_history_count( &self, ) -> GetGuestUserHistoryCountFluentBuilder

Constructs a fluent builder for the GetGuestUserHistoryCount operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network for which to retrieve guest user history.

    
    
• On success, responds with GetGuestUserHistoryCountOutput with field(s):
  • history(Vec::<GuestUserHistoryCount>):

    A list of historical guest user counts, organized by month and billing period.

• On failure, responds with SdkError<GetGuestUserHistoryCountError>

impl Client

pub fn get_network(&self) -> GetNetworkFluentBuilder

Constructs a fluent builder for the GetNetwork operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network to retrieve.

    
    
• On success, responds with GetNetworkOutput with field(s):
  • network_id(String):

    The unique identifier of the network.

  • network_name(String):

    The name of the network.

  • access_level(AccessLevel):

    The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.

  • aws_account_id(String):

    The Amazon Web Services account ID that owns the network.

  • network_arn(String):

    The Amazon Resource Name (ARN) of the network.

  • standing(Option<i32>):

    The current standing or status of the network.

  • free_trial_expiration(Option<String>):

    The expiration date and time for the network’s free trial period, if applicable.

  • migration_state(Option<i32>):

    The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).

  • encryption_key_arn(Option<String>):

    The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.

• On failure, responds with SdkError<GetNetworkError>

impl Client

pub fn get_network_settings(&self) -> GetNetworkSettingsFluentBuilder

Constructs a fluent builder for the GetNetworkSettings operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network whose settings will be retrieved.

    
    
• On success, responds with GetNetworkSettingsOutput with field(s):
  • settings(Vec::<Setting>):

    A list of network settings, where each setting includes a name, value, and type.

• On failure, responds with SdkError<GetNetworkSettingsError>

impl Client

pub fn get_oidc_info(&self) -> GetOidcInfoFluentBuilder

Constructs a fluent builder for the GetOidcInfo operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network whose OIDC configuration will be retrieved.

    
    
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: false
    

    The OAuth client ID for retrieving access tokens (optional).

    
    
  • code(impl Into<String>) / set_code(Option<String>):
    required: false
    

    The authorization code for retrieving access tokens (optional).

    
    
  • grant_type(impl Into<String>) / set_grant_type(Option<String>):
    required: false
    

    The OAuth grant type for retrieving access tokens (optional).

    
    
  • redirect_uri(impl Into<String>) / set_redirect_uri(Option<String>):
    required: false
    

    The redirect URI for the OAuth flow (optional).

    
    
  • url(impl Into<String>) / set_url(Option<String>):
    required: false
    

    The URL for the OIDC provider (optional).

    
    
  • client_secret(impl Into<String>) / set_client_secret(Option<String>):
    required: false
    

    The OAuth client secret for retrieving access tokens (optional).

    
    
  • code_verifier(impl Into<String>) / set_code_verifier(Option<String>):
    required: false
    

    The PKCE code verifier for enhanced security in the OAuth flow (optional).

    
    
  • certificate(impl Into<String>) / set_certificate(Option<String>):
    required: false
    

    The CA certificate for secure communication with the OIDC provider (optional).

    
    
• On success, responds with GetOidcInfoOutput with field(s):
  • openid_connect_info(Option<OidcConfigInfo>):

    The OpenID Connect configuration information for the network, including issuer, client ID, scopes, and other SSO settings.

  • token_info(Option<OidcTokenInfo>):

    OAuth token information including access token, refresh token, and expiration details (only present if token parameters were provided in the request).

• On failure, responds with SdkError<GetOidcInfoError>

impl Client

pub fn get_security_group(&self) -> GetSecurityGroupFluentBuilder

Constructs a fluent builder for the GetSecurityGroup operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the security group.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The unique identifier of the security group to retrieve.

    
    
• On success, responds with GetSecurityGroupOutput with field(s):
  • security_group(Option<SecurityGroup>):

    The detailed information about the security group, including all its settings and member counts.

• On failure, responds with SdkError<GetSecurityGroupError>

impl Client

pub fn get_user(&self) -> GetUserFluentBuilder

Constructs a fluent builder for the GetUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier of the user to retrieve.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The start time for filtering the user’s last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end time for filtering the user’s last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.

    
    
• On success, responds with GetUserOutput with field(s):
  • user_id(String):

    The unique identifier of the user.

  • first_name(Option<String>):

    The first name of the user.

  • last_name(Option<String>):

    The last name of the user.

  • username(Option<String>):

    The email address or username of the user.

  • is_admin(Option<bool>):

    Indicates whether the user has administrator privileges in the network.

  • suspended(Option<bool>):

    Indicates whether the user is currently suspended.

  • status(Option<i32>):

    The current status of the user (1 for pending, 2 for active).

  • last_activity(Option<i32>):

    The timestamp of the user’s last activity in the network, specified in epoch seconds.

  • last_login(Option<i32>):

    The timestamp of the user’s last login to the network, specified in epoch seconds.

  • security_group_ids(Option<Vec::<String>>):

    A list of security group IDs to which the user belongs.

• On failure, responds with SdkError<GetUserError>

impl Client

pub fn get_users_count(&self) -> GetUsersCountFluentBuilder

Constructs a fluent builder for the GetUsersCount operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network for which to retrieve user counts.

    
    
• On success, responds with GetUsersCountOutput with field(s):
  • pending(i32):

    The number of users with pending status (invited but not yet accepted).

  • active(i32):

    The number of users with active status in the network.

  • rejected(i32):

    The number of users who have rejected network invitations.

  • remaining(i32):

    The number of additional users that can be added to the network while maintaining premium free trial eligibility.

  • total(i32):

    The total number of users in the network (active and pending combined).

• On failure, responds with SdkError<GetUsersCountError>

impl Client

pub fn list_blocked_guest_users(&self) -> ListBlockedGuestUsersFluentBuilder

Constructs a fluent builder for the ListBlockedGuestUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which to list blocked guest users.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The field to sort blocked guest users by. Accepted values include ‘username’, ‘admin’, and ‘modified’.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    Filter results to only include blocked guest users with usernames matching this value.

    
    
  • admin(impl Into<String>) / set_admin(Option<String>):
    required: false
    

    Filter results to only include blocked guest users that were blocked by this administrator.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
• On success, responds with ListBlockedGuestUsersOutput with field(s):
  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

  • blocklist(Vec::<BlockedGuestUser>):

    A list of blocked guest user objects within the current page.

• On failure, responds with SdkError<ListBlockedGuestUsersError>

impl Client

pub fn list_bots(&self) -> ListBotsFluentBuilder

Constructs a fluent builder for the ListBots operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which to list bots.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of bots to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The fields to sort bots by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘username’, ‘firstName’, ‘displayName’, ‘status’, and ‘groupId’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    Filter results to only include bots with display names matching this value.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    Filter results to only include bots with usernames matching this value.

    
    
  • status(i32) / set_status(Option<i32>):
    required: false
    

    Filter results to only include bots with this status (1 for pending, 2 for active).

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: false
    

    Filter results to only include bots belonging to this security group.

    
    
• On success, responds with ListBotsOutput with field(s):
  • bots(Vec::<Bot>):

    A list of bot objects matching the specified filters and within the current page.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

• On failure, responds with SdkError<ListBotsError>

impl Client

pub fn list_devices_for_user(&self) -> ListDevicesForUserFluentBuilder

Constructs a fluent builder for the ListDevicesForUser operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier of the user whose devices will be listed.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The fields to sort devices by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘lastlogin’, ‘type’, ‘suspend’, and ‘created’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
• On success, responds with ListDevicesForUserOutput with field(s):
  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

  • devices(Vec::<BasicDeviceObject>):

    A list of device objects associated with the user within the current page.

• On failure, responds with SdkError<ListDevicesForUserError>

impl Client

pub fn list_guest_users(&self) -> ListGuestUsersFluentBuilder

Constructs a fluent builder for the ListGuestUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which to list guest users.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The field to sort guest users by. Accepted values include ‘username’ and ‘billingPeriod’.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    Filter results to only include guest users with usernames matching this value.

    
    
  • billing_period(impl Into<String>) / set_billing_period(Option<String>):
    required: false
    

    Filter results to only include guest users from this billing period (e.g., ‘2024-01’).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
• On success, responds with ListGuestUsersOutput with field(s):
  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

  • guestlist(Vec::<GuestUser>):

    A list of guest user objects within the current page.

• On failure, responds with SdkError<ListGuestUsersError>

impl Client

pub fn list_networks(&self) -> ListNetworksFluentBuilder

Constructs a fluent builder for the ListNetworks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of networks to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The field to sort networks by. Accepted values are ‘networkId’ and ‘networkName’. Default is ‘networkId’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
• On success, responds with ListNetworksOutput with field(s):
  • networks(Vec::<Network>):

    A list of network objects for the Amazon Web Services account.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

• On failure, responds with SdkError<ListNetworksError>

impl Client

pub fn list_security_group_users(&self) -> ListSecurityGroupUsersFluentBuilder

Constructs a fluent builder for the ListSecurityGroupUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the security group.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The unique identifier of the security group whose users will be listed.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The field to sort users by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘username’, ‘firstName’, and ‘lastName’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
• On success, responds with ListSecurityGroupUsersOutput with field(s):
  • users(Vec::<User>):

    A list of user objects belonging to the security group within the current page.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

• On failure, responds with SdkError<ListSecurityGroupUsersError>

impl Client

pub fn list_security_groups(&self) -> ListSecurityGroupsFluentBuilder

Constructs a fluent builder for the ListSecurityGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which to list security groups.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of security groups to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The field to sort security groups by. Accepted values include ‘id’ and ‘name’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
• On success, responds with ListSecurityGroupsOutput with field(s):
  • security_groups(Option<Vec::<SecurityGroup>>):

    A list of security group objects in the current page.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

• On failure, responds with SdkError<ListSecurityGroupsError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

Constructs a fluent builder for the ListUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network from which to list users.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

    
    
  • sort_fields(impl Into<String>) / set_sort_fields(Option<String>):
    required: false
    

    The fields to sort users by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘username’, ‘firstName’, ‘lastName’, ‘status’, and ‘groupId’.

    
    
  • sort_direction(SortDirection) / set_sort_direction(Option<SortDirection>):
    required: false
    

    The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    Filter results to only include users with first names matching this value.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    Filter results to only include users with last names matching this value.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    Filter results to only include users with usernames matching this value.

    
    
  • status(i32) / set_status(Option<i32>):
    required: false
    

    Filter results to only include users with this status (1 for pending, 2 for active).

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: false
    

    Filter results to only include users belonging to this security group.

    
    
• On success, responds with ListUsersOutput with field(s):
  • next_token(Option<String>):

    The token to use for retrieving the next page of results. If this is not present, there are no more results.

  • users(Option<Vec::<User>>):

    A list of user objects matching the specified filters and within the current page.

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn register_oidc_config(&self) -> RegisterOidcConfigFluentBuilder

Constructs a fluent builder for the RegisterOidcConfig operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network for which OIDC will be configured.

    
    
  • company_id(impl Into<String>) / set_company_id(Option<String>):
    required: true
    

    Custom identifier your end users will use to sign in with SSO.

    
    
  • custom_username(impl Into<String>) / set_custom_username(Option<String>):
    required: false
    

    A custom field mapping to extract the username from the OIDC token (optional).

    The customUsername is only required if you use something other than email as the username field.

    
    
  • extra_auth_params(impl Into<String>) / set_extra_auth_params(Option<String>):
    required: false
    

    Additional authentication parameters to include in the OIDC flow (optional).

    
    
  • issuer(impl Into<String>) / set_issuer(Option<String>):
    required: true
    

    The issuer URL of the OIDC provider (e.g., ‘https://login.example.com’).

    
    
  • scopes(impl Into<String>) / set_scopes(Option<String>):
    required: true
    

    The OAuth scopes to request from the OIDC provider (e.g., ‘openid profile email’).

    
    
  • secret(impl Into<String>) / set_secret(Option<String>):
    required: false
    

    The client secret for authenticating with the OIDC provider (optional).

    
    
  • sso_token_buffer_minutes(i32) / set_sso_token_buffer_minutes(Option<i32>):
    required: false
    

    The buffer time in minutes before the SSO token expires to refresh it (optional).

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.

    
    
• On success, responds with RegisterOidcConfigOutput with field(s):
  • application_name(Option<String>):

    The name of the registered OIDC application.

  • client_id(Option<String>):

    The OAuth client ID assigned to the application.

  • company_id(String):

    Custom identifier your end users will use to sign in with SSO.

  • scopes(String):

    The OAuth scopes configured for the application.

  • issuer(String):

    The issuer URL of the OIDC provider.

  • client_secret(Option<String>):

    The OAuth client secret for the application.

  • secret(Option<String>):

    The client secret for authenticating with the OIDC provider.

  • redirect_url(Option<String>):

    The redirect URL configured for the OAuth flow.

  • user_id(Option<String>):

    The claim field being used as the user identifier.

  • custom_username(Option<String>):

    The custom field mapping used for extracting the username.

  • ca_certificate(Option<String>):

    The CA certificate used for secure communication with the OIDC provider.

  • application_id(Option<i32>):

    The unique identifier for the registered OIDC application.

  • sso_token_buffer_minutes(Option<i32>):

    The buffer time in minutes before the SSO token expires.

  • extra_auth_params(Option<String>):

    The additional authentication parameters configured for the OIDC flow.

• On failure, responds with SdkError<RegisterOidcConfigError>

impl Client

pub fn register_oidc_config_test(&self) -> RegisterOidcConfigTestFluentBuilder

Constructs a fluent builder for the RegisterOidcConfigTest operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network for which the OIDC configuration will be tested.

    
    
  • extra_auth_params(impl Into<String>) / set_extra_auth_params(Option<String>):
    required: false
    

    Additional authentication parameters to include in the test (optional).

    
    
  • issuer(impl Into<String>) / set_issuer(Option<String>):
    required: true
    

    The issuer URL of the OIDC provider to test.

    
    
  • scopes(impl Into<String>) / set_scopes(Option<String>):
    required: true
    

    The OAuth scopes to test with the OIDC provider.

    
    
  • certificate(impl Into<String>) / set_certificate(Option<String>):
    required: false
    

    The CA certificate for secure communication with the OIDC provider (optional).

    
    
• On success, responds with RegisterOidcConfigTestOutput with field(s):
  • token_endpoint(Option<String>):

    The token endpoint URL discovered from the OIDC provider.

  • userinfo_endpoint(Option<String>):

    The user info endpoint URL discovered from the OIDC provider.

  • response_types_supported(Option<Vec::<String>>):

    The OAuth response types supported by the OIDC provider.

  • scopes_supported(Option<Vec::<String>>):

    The OAuth scopes supported by the OIDC provider.

  • issuer(Option<String>):

    The issuer URL confirmed by the OIDC provider.

  • authorization_endpoint(Option<String>):

    The authorization endpoint URL discovered from the OIDC provider.

  • end_session_endpoint(Option<String>):

    The end session endpoint URL for logging out users from the OIDC provider.

  • logout_endpoint(Option<String>):

    The logout endpoint URL for terminating user sessions.

  • grant_types_supported(Option<Vec::<String>>):

    The OAuth grant types supported by the OIDC provider.

  • revocation_endpoint(Option<String>):

    The token revocation endpoint URL for invalidating tokens.

  • token_endpoint_auth_methods_supported(Option<Vec::<String>>):

    The authentication methods supported by the token endpoint.

  • microsoft_multi_refresh_token(Option<bool>):

    Indicates whether the provider supports Microsoft multi-refresh tokens.

• On failure, responds with SdkError<RegisterOidcConfigTestError>

impl Client

pub fn update_bot(&self) -> UpdateBotFluentBuilder

Constructs a fluent builder for the UpdateBot operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the bot to update.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The unique identifier of the bot to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new display name for the bot.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: false
    

    The ID of the new security group to assign the bot to.

    
    
  • challenge(impl Into<String>) / set_challenge(Option<String>):
    required: false
    

    The new password for the bot account.

    
    
  • suspend(bool) / set_suspend(Option<bool>):
    required: false
    

    Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don’t affect suspension status.

    
    
• On success, responds with UpdateBotOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the bot update operation.

• On failure, responds with SdkError<UpdateBotError>

impl Client

pub fn update_data_retention(&self) -> UpdateDataRetentionFluentBuilder

Constructs a fluent builder for the UpdateDataRetention operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the data retention bot.

    
    
  • action_type(DataRetentionActionType) / set_action_type(Option<DataRetentionActionType>):
    required: true
    

    The action to perform. Valid values are ‘ENABLE’ (to enable the data retention service), ‘DISABLE’ (to disable the service), or ‘PUBKEY_MSG_ACK’ (to acknowledge the public key message).

    
    
• On success, responds with UpdateDataRetentionOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the update operation.

• On failure, responds with SdkError<UpdateDataRetentionError>

impl Client

pub fn update_guest_user(&self) -> UpdateGuestUserFluentBuilder

Constructs a fluent builder for the UpdateGuestUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network where the guest user’s status will be updated.

    
    
  • username_hash(impl Into<String>) / set_username_hash(Option<String>):
    required: true
    

    The username hash (unique identifier) of the guest user to update.

    
    
  • block(bool) / set_block(Option<bool>):
    required: true
    

    Set to true to block the guest user or false to unblock them.

    
    
• On success, responds with UpdateGuestUserOutput with field(s):
  • message(Option<String>):

    A message indicating the result of the update operation.

• On failure, responds with SdkError<UpdateGuestUserError>

impl Client

pub fn update_network(&self) -> UpdateNetworkFluentBuilder

Constructs a fluent builder for the UpdateNetwork operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network to update.

    
    
  • network_name(impl Into<String>) / set_network_name(Option<String>):
    required: true
    

    The new name for the network. Must be between 1 and 20 characters.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this request to ensure idempotency.

    
    
  • encryption_key_arn(impl Into<String>) / set_encryption_key_arn(Option<String>):
    required: false
    

    The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.

    
    
• On success, responds with UpdateNetworkOutput with field(s):
  • message(Option<String>):

    A message indicating that the network was updated successfully.

• On failure, responds with SdkError<UpdateNetworkError>

impl Client

pub fn update_network_settings(&self) -> UpdateNetworkSettingsFluentBuilder

Constructs a fluent builder for the UpdateNetworkSettings operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network whose settings will be updated.

    
    
  • settings(NetworkSettings) / set_settings(Option<NetworkSettings>):
    required: true
    

    A map of setting names to their new values. Each setting should be provided with its appropriate type (boolean, string, number, etc.).

    
    
• On success, responds with UpdateNetworkSettingsOutput with field(s):
  • settings(Vec::<Setting>):

    A list of the updated network settings, showing the new values for each modified setting.

• On failure, responds with SdkError<UpdateNetworkSettingsError>

impl Client

pub fn update_security_group(&self) -> UpdateSecurityGroupFluentBuilder

Constructs a fluent builder for the UpdateSecurityGroup operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the security group to update.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The unique identifier of the security group to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name for the security group.

    
    
  • security_group_settings(SecurityGroupSettings) / set_security_group_settings(Option<SecurityGroupSettings>):
    required: false
    

    The updated configuration settings for the security group.

    Federation mode - 0 (Local federation), 1 (Restricted federation), 2 (Global federation)

    
    
• On success, responds with UpdateSecurityGroupOutput with field(s):
  • security_group(Option<SecurityGroup>):

    The updated security group details, including the new settings.

• On failure, responds with SdkError<UpdateSecurityGroupError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

• The fluent builder is configurable:
  • network_id(impl Into<String>) / set_network_id(Option<String>):
    required: true
    

    The ID of the Wickr network containing the user to update.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The unique identifier of the user to update.

    
    
  • user_details(UpdateUserDetails) / set_user_details(Option<UpdateUserDetails>):
    required: false
    

    An object containing the user details to be updated, such as name, password, security groups, and invite code settings.

    
    
• On success, responds with UpdateUserOutput with field(s):
  • user_id(String):

    The unique identifier of the updated user.

  • network_id(String):

    The ID of the network where the user was updated.

  • security_group_ids(Option<Vec::<String>>):

    The list of security group IDs to which the user now belongs after the update.

  • first_name(Option<String>):

    The updated first name of the user.

  • last_name(Option<String>):

    The updated last name of the user.

  • middle_name(Option<String>):

    The middle name of the user (currently not used).

  • suspended(bool):

    Indicates whether the user is suspended after the update.

  • modified(Option<i32>):

    The timestamp when the user was last modified, specified in epoch seconds.

  • status(Option<i32>):

    The user’s status after the update.

  • invite_code(Option<String>):

    The updated invite code for the user, if applicable.

  • invite_expiration(Option<i32>):

    The expiration time of the user’s invite code, specified in epoch seconds.

  • code_validation(Option<bool>):

    Indicates whether the user can be verified through a custom invite code.

• On failure, responds with SdkError<UpdateUserError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.