WickrAdminAPIClient

Index > WickrAdminAPI > WickrAdminAPIClient

Auto-generated documentation for WickrAdminAPI type annotations stubs module mypy-boto3-wickr.

WickrAdminAPIClient

Type annotations and code completion for boto3.client("wickr"). boto3 documentation

# WickrAdminAPIClient usage example

from boto3.session import Session
from mypy_boto3_wickr.client import WickrAdminAPIClient

def get_wickr_client() -> WickrAdminAPIClient:
    return Session().client("wickr")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("wickr").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("wickr")

try:
    do_something(client)
except (
    client.exceptions.BadRequestError,
    client.exceptions.ClientError,
    client.exceptions.ForbiddenError,
    client.exceptions.InternalServerError,
    client.exceptions.RateLimitError,
    client.exceptions.ResourceNotFoundError,
    client.exceptions.UnauthorizedError,
    client.exceptions.ValidationError,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_wickr.client import Exceptions

def handle_error(exc: Exceptions.BadRequestError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("wickr").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("wickr").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_create_user

Creates multiple users in a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").batch_create_user method. boto3 documentation

# batch_create_user method definition

def batch_create_user(
    self,
    *,
    networkId: str,
    users: Sequence[BatchCreateUserRequestItemTypeDef],  # (1)
    clientToken: str = ...,
) -> BatchCreateUserResponseTypeDef:  # (2)
    ...

1. See Sequence[BatchCreateUserRequestItemTypeDef]
2. See BatchCreateUserResponseTypeDef

# batch_create_user method usage example with argument unpacking

kwargs: BatchCreateUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "users": ...,
}

parent.batch_create_user(**kwargs)

1. See BatchCreateUserRequestTypeDef

batch_delete_user

Deletes multiple users from a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").batch_delete_user method. boto3 documentation

# batch_delete_user method definition

def batch_delete_user(
    self,
    *,
    networkId: str,
    userIds: Sequence[str],
    clientToken: str = ...,
) -> BatchDeleteUserResponseTypeDef:  # (1)
    ...

1. See BatchDeleteUserResponseTypeDef

# batch_delete_user method usage example with argument unpacking

kwargs: BatchDeleteUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userIds": ...,
}

parent.batch_delete_user(**kwargs)

1. See BatchDeleteUserRequestTypeDef

batch_lookup_user_uname

Looks up multiple user usernames from their unique username hashes (unames).

Type annotations and code completion for boto3.client("wickr").batch_lookup_user_uname method. boto3 documentation

# batch_lookup_user_uname method definition

def batch_lookup_user_uname(
    self,
    *,
    networkId: str,
    unames: Sequence[str],
    clientToken: str = ...,
) -> BatchLookupUserUnameResponseTypeDef:  # (1)
    ...

1. See BatchLookupUserUnameResponseTypeDef

# batch_lookup_user_uname method usage example with argument unpacking

kwargs: BatchLookupUserUnameRequestTypeDef = {  # (1)
    "networkId": ...,
    "unames": ...,
}

parent.batch_lookup_user_uname(**kwargs)

1. See BatchLookupUserUnameRequestTypeDef

batch_reinvite_user

Resends invitation codes to multiple users who have pending invitations in a Wickr network.

Type annotations and code completion for boto3.client("wickr").batch_reinvite_user method. boto3 documentation

# batch_reinvite_user method definition

def batch_reinvite_user(
    self,
    *,
    networkId: str,
    userIds: Sequence[str],
    clientToken: str = ...,
) -> BatchReinviteUserResponseTypeDef:  # (1)
    ...

1. See BatchReinviteUserResponseTypeDef

# batch_reinvite_user method usage example with argument unpacking

kwargs: BatchReinviteUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userIds": ...,
}

parent.batch_reinvite_user(**kwargs)

1. See BatchReinviteUserRequestTypeDef

batch_reset_devices_for_user

Resets multiple devices for a specific user in a Wickr network.

Type annotations and code completion for boto3.client("wickr").batch_reset_devices_for_user method. boto3 documentation

# batch_reset_devices_for_user method definition

def batch_reset_devices_for_user(
    self,
    *,
    networkId: str,
    userId: str,
    appIds: Sequence[str],
    clientToken: str = ...,
) -> BatchResetDevicesForUserResponseTypeDef:  # (1)
    ...

1. See BatchResetDevicesForUserResponseTypeDef

# batch_reset_devices_for_user method usage example with argument unpacking

kwargs: BatchResetDevicesForUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userId": ...,
    "appIds": ...,
}

parent.batch_reset_devices_for_user(**kwargs)

1. See BatchResetDevicesForUserRequestTypeDef

batch_toggle_user_suspend_status

Suspends or unsuspends multiple users in a Wickr network.

Type annotations and code completion for boto3.client("wickr").batch_toggle_user_suspend_status method. boto3 documentation

# batch_toggle_user_suspend_status method definition

def batch_toggle_user_suspend_status(
    self,
    *,
    networkId: str,
    suspend: bool,
    userIds: Sequence[str],
    clientToken: str = ...,
) -> BatchToggleUserSuspendStatusResponseTypeDef:  # (1)
    ...

1. See BatchToggleUserSuspendStatusResponseTypeDef

# batch_toggle_user_suspend_status method usage example with argument unpacking

kwargs: BatchToggleUserSuspendStatusRequestTypeDef = {  # (1)
    "networkId": ...,
    "suspend": ...,
    "userIds": ...,
}

parent.batch_toggle_user_suspend_status(**kwargs)

1. See BatchToggleUserSuspendStatusRequestTypeDef

create_bot

Creates a new bot in a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").create_bot method. boto3 documentation

# create_bot method definition

def create_bot(
    self,
    *,
    networkId: str,
    username: str,
    groupId: str,
    challenge: str,
    displayName: str = ...,
) -> CreateBotResponseTypeDef:  # (1)
    ...

1. See CreateBotResponseTypeDef

# create_bot method usage example with argument unpacking

kwargs: CreateBotRequestTypeDef = {  # (1)
    "networkId": ...,
    "username": ...,
    "groupId": ...,
    "challenge": ...,
}

parent.create_bot(**kwargs)

1. See CreateBotRequestTypeDef

create_data_retention_bot

Creates a data retention bot in a Wickr network.

Type annotations and code completion for boto3.client("wickr").create_data_retention_bot method. boto3 documentation

# create_data_retention_bot method definition

def create_data_retention_bot(
    self,
    *,
    networkId: str,
) -> CreateDataRetentionBotResponseTypeDef:  # (1)
    ...

1. See CreateDataRetentionBotResponseTypeDef

# create_data_retention_bot method usage example with argument unpacking

kwargs: CreateDataRetentionBotRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.create_data_retention_bot(**kwargs)

1. See CreateDataRetentionBotRequestTypeDef

create_data_retention_bot_challenge

Creates a new challenge password for the data retention bot.

Type annotations and code completion for boto3.client("wickr").create_data_retention_bot_challenge method. boto3 documentation

# create_data_retention_bot_challenge method definition

def create_data_retention_bot_challenge(
    self,
    *,
    networkId: str,
) -> CreateDataRetentionBotChallengeResponseTypeDef:  # (1)
    ...

1. See CreateDataRetentionBotChallengeResponseTypeDef

# create_data_retention_bot_challenge method usage example with argument unpacking

kwargs: CreateDataRetentionBotChallengeRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.create_data_retention_bot_challenge(**kwargs)

1. See CreateDataRetentionBotChallengeRequestTypeDef

create_network

Creates a new Wickr network with specified access level and configuration.

Type annotations and code completion for boto3.client("wickr").create_network method. boto3 documentation

# create_network method definition

def create_network(
    self,
    *,
    networkName: str,
    accessLevel: AccessLevelType,  # (1)
    enablePremiumFreeTrial: bool = ...,
    encryptionKeyArn: str = ...,
) -> CreateNetworkResponseTypeDef:  # (2)
    ...

1. See AccessLevelType
2. See CreateNetworkResponseTypeDef

# create_network method usage example with argument unpacking

kwargs: CreateNetworkRequestTypeDef = {  # (1)
    "networkName": ...,
    "accessLevel": ...,
}

parent.create_network(**kwargs)

1. See CreateNetworkRequestTypeDef

create_security_group

Creates a new security group in a Wickr network.

Type annotations and code completion for boto3.client("wickr").create_security_group method. boto3 documentation

# create_security_group method definition

def create_security_group(
    self,
    *,
    networkId: str,
    name: str,
    securityGroupSettings: SecurityGroupSettingsRequestTypeDef,  # (1)
    clientToken: str = ...,
) -> CreateSecurityGroupResponseTypeDef:  # (2)
    ...

1. See SecurityGroupSettingsRequestTypeDef
2. See CreateSecurityGroupResponseTypeDef

# create_security_group method usage example with argument unpacking

kwargs: CreateSecurityGroupRequestTypeDef = {  # (1)
    "networkId": ...,
    "name": ...,
    "securityGroupSettings": ...,
}

parent.create_security_group(**kwargs)

1. See CreateSecurityGroupRequestTypeDef

delete_bot

Deletes a bot from a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").delete_bot method. boto3 documentation

# delete_bot method definition

def delete_bot(
    self,
    *,
    networkId: str,
    botId: str,
) -> DeleteBotResponseTypeDef:  # (1)
    ...

1. See DeleteBotResponseTypeDef

# delete_bot method usage example with argument unpacking

kwargs: DeleteBotRequestTypeDef = {  # (1)
    "networkId": ...,
    "botId": ...,
}

parent.delete_bot(**kwargs)

1. See DeleteBotRequestTypeDef

delete_data_retention_bot

Deletes the data retention bot from a Wickr network.

Type annotations and code completion for boto3.client("wickr").delete_data_retention_bot method. boto3 documentation

# delete_data_retention_bot method definition

def delete_data_retention_bot(
    self,
    *,
    networkId: str,
) -> DeleteDataRetentionBotResponseTypeDef:  # (1)
    ...

1. See DeleteDataRetentionBotResponseTypeDef

# delete_data_retention_bot method usage example with argument unpacking

kwargs: DeleteDataRetentionBotRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.delete_data_retention_bot(**kwargs)

1. See DeleteDataRetentionBotRequestTypeDef

delete_network

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings.

Type annotations and code completion for boto3.client("wickr").delete_network method. boto3 documentation

# delete_network method definition

def delete_network(
    self,
    *,
    networkId: str,
    clientToken: str = ...,
) -> DeleteNetworkResponseTypeDef:  # (1)
    ...

1. See DeleteNetworkResponseTypeDef

# delete_network method usage example with argument unpacking

kwargs: DeleteNetworkRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.delete_network(**kwargs)

1. See DeleteNetworkRequestTypeDef

delete_security_group

Deletes a security group from a Wickr network.

Type annotations and code completion for boto3.client("wickr").delete_security_group method. boto3 documentation

# delete_security_group method definition

def delete_security_group(
    self,
    *,
    networkId: str,
    groupId: str,
) -> DeleteSecurityGroupResponseTypeDef:  # (1)
    ...

1. See DeleteSecurityGroupResponseTypeDef

# delete_security_group method usage example with argument unpacking

kwargs: DeleteSecurityGroupRequestTypeDef = {  # (1)
    "networkId": ...,
    "groupId": ...,
}

parent.delete_security_group(**kwargs)

1. See DeleteSecurityGroupRequestTypeDef

get_bot

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

Type annotations and code completion for boto3.client("wickr").get_bot method. boto3 documentation

# get_bot method definition

def get_bot(
    self,
    *,
    networkId: str,
    botId: str,
) -> GetBotResponseTypeDef:  # (1)
    ...

1. See GetBotResponseTypeDef

# get_bot method usage example with argument unpacking

kwargs: GetBotRequestTypeDef = {  # (1)
    "networkId": ...,
    "botId": ...,
}

parent.get_bot(**kwargs)

1. See GetBotRequestTypeDef

get_bots_count

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

Type annotations and code completion for boto3.client("wickr").get_bots_count method. boto3 documentation

# get_bots_count method definition

def get_bots_count(
    self,
    *,
    networkId: str,
) -> GetBotsCountResponseTypeDef:  # (1)
    ...

1. See GetBotsCountResponseTypeDef

# get_bots_count method usage example with argument unpacking

kwargs: GetBotsCountRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_bots_count(**kwargs)

1. See GetBotsCountRequestTypeDef

get_data_retention_bot

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

Type annotations and code completion for boto3.client("wickr").get_data_retention_bot method. boto3 documentation

# get_data_retention_bot method definition

def get_data_retention_bot(
    self,
    *,
    networkId: str,
) -> GetDataRetentionBotResponseTypeDef:  # (1)
    ...

1. See GetDataRetentionBotResponseTypeDef

# get_data_retention_bot method usage example with argument unpacking

kwargs: GetDataRetentionBotRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_data_retention_bot(**kwargs)

1. See GetDataRetentionBotRequestTypeDef

get_guest_user_history_count

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

Type annotations and code completion for boto3.client("wickr").get_guest_user_history_count method. boto3 documentation

# get_guest_user_history_count method definition

def get_guest_user_history_count(
    self,
    *,
    networkId: str,
) -> GetGuestUserHistoryCountResponseTypeDef:  # (1)
    ...

1. See GetGuestUserHistoryCountResponseTypeDef

# get_guest_user_history_count method usage example with argument unpacking

kwargs: GetGuestUserHistoryCountRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_guest_user_history_count(**kwargs)

1. See GetGuestUserHistoryCountRequestTypeDef

get_network

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

Type annotations and code completion for boto3.client("wickr").get_network method. boto3 documentation

# get_network method definition

def get_network(
    self,
    *,
    networkId: str,
) -> GetNetworkResponseTypeDef:  # (1)
    ...

1. See GetNetworkResponseTypeDef

# get_network method usage example with argument unpacking

kwargs: GetNetworkRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_network(**kwargs)

1. See GetNetworkRequestTypeDef

get_network_settings

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

Type annotations and code completion for boto3.client("wickr").get_network_settings method. boto3 documentation

# get_network_settings method definition

def get_network_settings(
    self,
    *,
    networkId: str,
) -> GetNetworkSettingsResponseTypeDef:  # (1)
    ...

1. See GetNetworkSettingsResponseTypeDef

# get_network_settings method usage example with argument unpacking

kwargs: GetNetworkSettingsRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_network_settings(**kwargs)

1. See GetNetworkSettingsRequestTypeDef

get_oidc_info

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

Type annotations and code completion for boto3.client("wickr").get_oidc_info method. boto3 documentation

# get_oidc_info method definition

def get_oidc_info(
    self,
    *,
    networkId: str,
    clientId: str = ...,
    code: str = ...,
    grantType: str = ...,
    redirectUri: str = ...,
    url: str = ...,
    clientSecret: str = ...,
    codeVerifier: str = ...,
    certificate: str = ...,
) -> GetOidcInfoResponseTypeDef:  # (1)
    ...

1. See GetOidcInfoResponseTypeDef

# get_oidc_info method usage example with argument unpacking

kwargs: GetOidcInfoRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_oidc_info(**kwargs)

1. See GetOidcInfoRequestTypeDef

get_security_group

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

Type annotations and code completion for boto3.client("wickr").get_security_group method. boto3 documentation

# get_security_group method definition

def get_security_group(
    self,
    *,
    networkId: str,
    groupId: str,
) -> GetSecurityGroupResponseTypeDef:  # (1)
    ...

1. See GetSecurityGroupResponseTypeDef

# get_security_group method usage example with argument unpacking

kwargs: GetSecurityGroupRequestTypeDef = {  # (1)
    "networkId": ...,
    "groupId": ...,
}

parent.get_security_group(**kwargs)

1. See GetSecurityGroupRequestTypeDef

get_user

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

Type annotations and code completion for boto3.client("wickr").get_user method. boto3 documentation

# get_user method definition

def get_user(
    self,
    *,
    networkId: str,
    userId: str,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
) -> GetUserResponseTypeDef:  # (1)
    ...

1. See GetUserResponseTypeDef

# get_user method usage example with argument unpacking

kwargs: GetUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userId": ...,
}

parent.get_user(**kwargs)

1. See GetUserRequestTypeDef

get_users_count

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.

Type annotations and code completion for boto3.client("wickr").get_users_count method. boto3 documentation

# get_users_count method definition

def get_users_count(
    self,
    *,
    networkId: str,
) -> GetUsersCountResponseTypeDef:  # (1)
    ...

1. See GetUsersCountResponseTypeDef

# get_users_count method usage example with argument unpacking

kwargs: GetUsersCountRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.get_users_count(**kwargs)

1. See GetUsersCountRequestTypeDef

list_blocked_guest_users

Retrieves a paginated list of guest users who have been blocked from a Wickr network.

Type annotations and code completion for boto3.client("wickr").list_blocked_guest_users method. boto3 documentation

# list_blocked_guest_users method definition

def list_blocked_guest_users(
    self,
    *,
    networkId: str,
    maxResults: int = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    sortFields: str = ...,
    username: str = ...,
    admin: str = ...,
    nextToken: str = ...,
) -> ListBlockedGuestUsersResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListBlockedGuestUsersResponseTypeDef

# list_blocked_guest_users method usage example with argument unpacking

kwargs: ListBlockedGuestUsersRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.list_blocked_guest_users(**kwargs)

1. See ListBlockedGuestUsersRequestTypeDef

list_bots

Retrieves a paginated list of bots in a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").list_bots method. boto3 documentation

# list_bots method definition

def list_bots(
    self,
    *,
    networkId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    displayName: str = ...,
    username: str = ...,
    status: int = ...,
    groupId: str = ...,
) -> ListBotsResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListBotsResponseTypeDef

# list_bots method usage example with argument unpacking

kwargs: ListBotsRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.list_bots(**kwargs)

1. See ListBotsRequestTypeDef

list_devices_for_user

Retrieves a paginated list of devices associated with a specific user in a Wickr network.

Type annotations and code completion for boto3.client("wickr").list_devices_for_user method. boto3 documentation

# list_devices_for_user method definition

def list_devices_for_user(
    self,
    *,
    networkId: str,
    userId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
) -> ListDevicesForUserResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListDevicesForUserResponseTypeDef

# list_devices_for_user method usage example with argument unpacking

kwargs: ListDevicesForUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userId": ...,
}

parent.list_devices_for_user(**kwargs)

1. See ListDevicesForUserRequestTypeDef

list_guest_users

Retrieves a paginated list of guest users who have communicated with your Wickr network.

Type annotations and code completion for boto3.client("wickr").list_guest_users method. boto3 documentation

# list_guest_users method definition

def list_guest_users(
    self,
    *,
    networkId: str,
    maxResults: int = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    sortFields: str = ...,
    username: str = ...,
    billingPeriod: str = ...,
    nextToken: str = ...,
) -> ListGuestUsersResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListGuestUsersResponseTypeDef

# list_guest_users method usage example with argument unpacking

kwargs: ListGuestUsersRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.list_guest_users(**kwargs)

1. See ListGuestUsersRequestTypeDef

list_networks

Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account.

Type annotations and code completion for boto3.client("wickr").list_networks method. boto3 documentation

# list_networks method definition

def list_networks(
    self,
    *,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    nextToken: str = ...,
) -> ListNetworksResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListNetworksResponseTypeDef

# list_networks method usage example with argument unpacking

kwargs: ListNetworksRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_networks(**kwargs)

1. See ListNetworksRequestTypeDef

list_security_group_users

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

Type annotations and code completion for boto3.client("wickr").list_security_group_users method. boto3 documentation

# list_security_group_users method definition

def list_security_group_users(
    self,
    *,
    networkId: str,
    groupId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
) -> ListSecurityGroupUsersResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListSecurityGroupUsersResponseTypeDef

# list_security_group_users method usage example with argument unpacking

kwargs: ListSecurityGroupUsersRequestTypeDef = {  # (1)
    "networkId": ...,
    "groupId": ...,
}

parent.list_security_group_users(**kwargs)

1. See ListSecurityGroupUsersRequestTypeDef

list_security_groups

Retrieves a paginated list of security groups in a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").list_security_groups method. boto3 documentation

# list_security_groups method definition

def list_security_groups(
    self,
    *,
    networkId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
) -> ListSecurityGroupsResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListSecurityGroupsResponseTypeDef

# list_security_groups method usage example with argument unpacking

kwargs: ListSecurityGroupsRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.list_security_groups(**kwargs)

1. See ListSecurityGroupsRequestTypeDef

list_users

Retrieves a paginated list of users in a specified Wickr network.

Type annotations and code completion for boto3.client("wickr").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    networkId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    firstName: str = ...,
    lastName: str = ...,
    username: str = ...,
    status: int = ...,
    groupId: str = ...,
) -> ListUsersResponseTypeDef:  # (2)
    ...

1. See SortDirectionType
2. See ListUsersResponseTypeDef

# list_users method usage example with argument unpacking

kwargs: ListUsersRequestTypeDef = {  # (1)
    "networkId": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestTypeDef

register_oidc_config

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

Type annotations and code completion for boto3.client("wickr").register_oidc_config method. boto3 documentation

# register_oidc_config method definition

def register_oidc_config(
    self,
    *,
    networkId: str,
    companyId: str,
    issuer: str,
    scopes: str,
    customUsername: str = ...,
    extraAuthParams: str = ...,
    secret: str = ...,
    ssoTokenBufferMinutes: int = ...,
    userId: str = ...,
) -> RegisterOidcConfigResponseTypeDef:  # (1)
    ...

1. See RegisterOidcConfigResponseTypeDef

# register_oidc_config method usage example with argument unpacking

kwargs: RegisterOidcConfigRequestTypeDef = {  # (1)
    "networkId": ...,
    "companyId": ...,
    "issuer": ...,
    "scopes": ...,
}

parent.register_oidc_config(**kwargs)

1. See RegisterOidcConfigRequestTypeDef

register_oidc_config_test

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

Type annotations and code completion for boto3.client("wickr").register_oidc_config_test method. boto3 documentation

# register_oidc_config_test method definition

def register_oidc_config_test(
    self,
    *,
    networkId: str,
    issuer: str,
    scopes: str,
    extraAuthParams: str = ...,
    certificate: str = ...,
) -> RegisterOidcConfigTestResponseTypeDef:  # (1)
    ...

1. See RegisterOidcConfigTestResponseTypeDef

# register_oidc_config_test method usage example with argument unpacking

kwargs: RegisterOidcConfigTestRequestTypeDef = {  # (1)
    "networkId": ...,
    "issuer": ...,
    "scopes": ...,
}

parent.register_oidc_config_test(**kwargs)

1. See RegisterOidcConfigTestRequestTypeDef

update_bot

Updates the properties of an existing bot in a Wickr network.

Type annotations and code completion for boto3.client("wickr").update_bot method. boto3 documentation

# update_bot method definition

def update_bot(
    self,
    *,
    networkId: str,
    botId: str,
    displayName: str = ...,
    groupId: str = ...,
    challenge: str = ...,
    suspend: bool = ...,
) -> UpdateBotResponseTypeDef:  # (1)
    ...

1. See UpdateBotResponseTypeDef

# update_bot method usage example with argument unpacking

kwargs: UpdateBotRequestTypeDef = {  # (1)
    "networkId": ...,
    "botId": ...,
}

parent.update_bot(**kwargs)

1. See UpdateBotRequestTypeDef

update_data_retention

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

Type annotations and code completion for boto3.client("wickr").update_data_retention method. boto3 documentation

# update_data_retention method definition

def update_data_retention(
    self,
    *,
    networkId: str,
    actionType: DataRetentionActionTypeType,  # (1)
) -> UpdateDataRetentionResponseTypeDef:  # (2)
    ...

1. See DataRetentionActionTypeType
2. See UpdateDataRetentionResponseTypeDef

# update_data_retention method usage example with argument unpacking

kwargs: UpdateDataRetentionRequestTypeDef = {  # (1)
    "networkId": ...,
    "actionType": ...,
}

parent.update_data_retention(**kwargs)

1. See UpdateDataRetentionRequestTypeDef

update_guest_user

Updates the block status of a guest user in a Wickr network.

Type annotations and code completion for boto3.client("wickr").update_guest_user method. boto3 documentation

# update_guest_user method definition

def update_guest_user(
    self,
    *,
    networkId: str,
    usernameHash: str,
    block: bool,
) -> UpdateGuestUserResponseTypeDef:  # (1)
    ...

1. See UpdateGuestUserResponseTypeDef

# update_guest_user method usage example with argument unpacking

kwargs: UpdateGuestUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "usernameHash": ...,
    "block": ...,
}

parent.update_guest_user(**kwargs)

1. See UpdateGuestUserRequestTypeDef

update_network

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

Type annotations and code completion for boto3.client("wickr").update_network method. boto3 documentation

# update_network method definition

def update_network(
    self,
    *,
    networkId: str,
    networkName: str,
    clientToken: str = ...,
    encryptionKeyArn: str = ...,
) -> UpdateNetworkResponseTypeDef:  # (1)
    ...

1. See UpdateNetworkResponseTypeDef

# update_network method usage example with argument unpacking

kwargs: UpdateNetworkRequestTypeDef = {  # (1)
    "networkId": ...,
    "networkName": ...,
}

parent.update_network(**kwargs)

1. See UpdateNetworkRequestTypeDef

update_network_settings

Updates network-level settings for a Wickr network.

Type annotations and code completion for boto3.client("wickr").update_network_settings method. boto3 documentation

# update_network_settings method definition

def update_network_settings(
    self,
    *,
    networkId: str,
    settings: NetworkSettingsTypeDef,  # (1)
) -> UpdateNetworkSettingsResponseTypeDef:  # (2)
    ...

1. See NetworkSettingsTypeDef
2. See UpdateNetworkSettingsResponseTypeDef

# update_network_settings method usage example with argument unpacking

kwargs: UpdateNetworkSettingsRequestTypeDef = {  # (1)
    "networkId": ...,
    "settings": ...,
}

parent.update_network_settings(**kwargs)

1. See UpdateNetworkSettingsRequestTypeDef

update_security_group

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

Type annotations and code completion for boto3.client("wickr").update_security_group method. boto3 documentation

# update_security_group method definition

def update_security_group(
    self,
    *,
    networkId: str,
    groupId: str,
    name: str = ...,
    securityGroupSettings: SecurityGroupSettingsUnionTypeDef = ...,  # (1)
) -> UpdateSecurityGroupResponseTypeDef:  # (2)
    ...

1. See SecurityGroupSettingsUnionTypeDef
2. See UpdateSecurityGroupResponseTypeDef

# update_security_group method usage example with argument unpacking

kwargs: UpdateSecurityGroupRequestTypeDef = {  # (1)
    "networkId": ...,
    "groupId": ...,
}

parent.update_security_group(**kwargs)

1. See UpdateSecurityGroupRequestTypeDef

update_user

Updates the properties of an existing user in a Wickr network.

Type annotations and code completion for boto3.client("wickr").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    networkId: str,
    userId: str,
    userDetails: UpdateUserDetailsTypeDef = ...,  # (1)
) -> UpdateUserResponseTypeDef:  # (2)
    ...

1. See UpdateUserDetailsTypeDef
2. See UpdateUserResponseTypeDef

# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestTypeDef = {  # (1)
    "networkId": ...,
    "userId": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("wickr").get_paginator method with overloads.

• client.get_paginator("list_blocked_guest_users") -> ListBlockedGuestUsersPaginator
• client.get_paginator("list_bots") -> ListBotsPaginator
• client.get_paginator("list_devices_for_user") -> ListDevicesForUserPaginator
• client.get_paginator("list_guest_users") -> ListGuestUsersPaginator
• client.get_paginator("list_networks") -> ListNetworksPaginator
• client.get_paginator("list_security_group_users") -> ListSecurityGroupUsersPaginator
• client.get_paginator("list_security_groups") -> ListSecurityGroupsPaginator
• client.get_paginator("list_users") -> ListUsersPaginator