WickrAdminAPI module#
Index > WickrAdminAPI
Auto-generated documentation for WickrAdminAPI type annotations stubs module mypy-boto3-wickr.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3 package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.42.14' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
WickrAdminAPIservice. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and WickrAdminAPI.
From PyPI with pip#
Install boto3-stubs for WickrAdminAPI service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[wickr]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[wickr]'
# standalone installation
python -m pip install mypy-boto3-wickr
How to uninstall#
python -m pip uninstall -y mypy-boto3-wickr
Usage#
Code samples can be found in Examples.
WickrAdminAPIClient#
Type annotations and code completion for boto3.client("wickr") as WickrAdminAPIClient
boto3 documentation
# WickrAdminAPIClient usage example
from boto3.session import Session
from mypy_boto3_wickr.client import WickrAdminAPIClient
def get_client() -> WickrAdminAPIClient:
return Session().client("wickr")
Paginators#
Type annotations and code completion for paginators
from boto3.client("wickr").get_paginator("...").
# ListBlockedGuestUsersPaginator usage example
from boto3.session import Session
from mypy_boto3_wickr.paginator import ListBlockedGuestUsersPaginator
def get_list_blocked_guest_users_paginator() -> ListBlockedGuestUsersPaginator:
return Session().client("wickr").get_paginator("list_blocked_guest_users"))
- ListBlockedGuestUsersPaginator
- ListBotsPaginator
- ListDevicesForUserPaginator
- ListGuestUsersPaginator
- ListNetworksPaginator
- ListSecurityGroupUsersPaginator
- ListSecurityGroupsPaginator
- ListUsersPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccessLevelType usage example
from mypy_boto3_wickr.literals import AccessLevelType
def get_value() -> AccessLevelType:
return "PREMIUM"
- AccessLevelType
- DataRetentionActionTypeType
- ListBlockedGuestUsersPaginatorName
- ListBotsPaginatorName
- ListDevicesForUserPaginatorName
- ListGuestUsersPaginatorName
- ListNetworksPaginatorName
- ListSecurityGroupUsersPaginatorName
- ListSecurityGroupsPaginatorName
- ListUsersPaginatorName
- SortDirectionType
- StatusType
- WickrAdminAPIServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BasicDeviceObjectTypeDef
- BatchCreateUserRequestItemTypeDef
- BatchUserErrorResponseItemTypeDef
- ResponseMetadataTypeDef
- UserTypeDef
- BatchDeleteUserRequestTypeDef
- BatchUserSuccessResponseItemTypeDef
- BatchDeviceErrorResponseItemTypeDef
- BatchDeviceSuccessResponseItemTypeDef
- BatchLookupUserUnameRequestTypeDef
- BatchUnameErrorResponseItemTypeDef
- BatchUnameSuccessResponseItemTypeDef
- BatchReinviteUserRequestTypeDef
- BatchResetDevicesForUserRequestTypeDef
- BatchToggleUserSuspendStatusRequestTypeDef
- BlockedGuestUserTypeDef
- BotTypeDef
- CallingSettingsTypeDef
- CreateBotRequestTypeDef
- CreateDataRetentionBotChallengeRequestTypeDef
- CreateDataRetentionBotRequestTypeDef
- CreateNetworkRequestTypeDef
- DeleteBotRequestTypeDef
- DeleteDataRetentionBotRequestTypeDef
- DeleteNetworkRequestTypeDef
- DeleteSecurityGroupRequestTypeDef
- GetBotRequestTypeDef
- GetBotsCountRequestTypeDef
- GetDataRetentionBotRequestTypeDef
- GetGuestUserHistoryCountRequestTypeDef
- GuestUserHistoryCountTypeDef
- GetNetworkRequestTypeDef
- GetNetworkSettingsRequestTypeDef
- SettingTypeDef
- GetOidcInfoRequestTypeDef
- OidcConfigInfoTypeDef
- OidcTokenInfoTypeDef
- GetSecurityGroupRequestTypeDef
- TimestampTypeDef
- GetUsersCountRequestTypeDef
- GuestUserTypeDef
- PaginatorConfigTypeDef
- ListBlockedGuestUsersRequestTypeDef
- ListBotsRequestTypeDef
- ListDevicesForUserRequestTypeDef
- ListGuestUsersRequestTypeDef
- ListNetworksRequestTypeDef
- NetworkTypeDef
- ListSecurityGroupUsersRequestTypeDef
- ListSecurityGroupsRequestTypeDef
- ListUsersRequestTypeDef
- ReadReceiptConfigTypeDef
- PasswordRequirementsTypeDef
- PermittedWickrEnterpriseNetworkTypeDef
- RegisterOidcConfigRequestTypeDef
- RegisterOidcConfigTestRequestTypeDef
- ShredderSettingsTypeDef
- WickrAwsNetworksTypeDef
- UpdateBotRequestTypeDef
- UpdateDataRetentionRequestTypeDef
- UpdateGuestUserRequestTypeDef
- UpdateNetworkRequestTypeDef
- UpdateUserDetailsTypeDef
- BatchCreateUserRequestTypeDef
- CreateBotResponseTypeDef
- CreateDataRetentionBotChallengeResponseTypeDef
- CreateDataRetentionBotResponseTypeDef
- CreateNetworkResponseTypeDef
- DeleteBotResponseTypeDef
- DeleteDataRetentionBotResponseTypeDef
- DeleteNetworkResponseTypeDef
- DeleteSecurityGroupResponseTypeDef
- GetBotResponseTypeDef
- GetBotsCountResponseTypeDef
- GetDataRetentionBotResponseTypeDef
- GetNetworkResponseTypeDef
- GetUserResponseTypeDef
- GetUsersCountResponseTypeDef
- ListDevicesForUserResponseTypeDef
- RegisterOidcConfigResponseTypeDef
- RegisterOidcConfigTestResponseTypeDef
- UpdateBotResponseTypeDef
- UpdateDataRetentionResponseTypeDef
- UpdateGuestUserResponseTypeDef
- UpdateNetworkResponseTypeDef
- UpdateUserResponseTypeDef
- BatchCreateUserResponseTypeDef
- ListSecurityGroupUsersResponseTypeDef
- ListUsersResponseTypeDef
- BatchDeleteUserResponseTypeDef
- BatchReinviteUserResponseTypeDef
- BatchToggleUserSuspendStatusResponseTypeDef
- BatchResetDevicesForUserResponseTypeDef
- BatchLookupUserUnameResponseTypeDef
- ListBlockedGuestUsersResponseTypeDef
- ListBotsResponseTypeDef
- GetGuestUserHistoryCountResponseTypeDef
- GetNetworkSettingsResponseTypeDef
- UpdateNetworkSettingsResponseTypeDef
- GetOidcInfoResponseTypeDef
- GetUserRequestTypeDef
- ListGuestUsersResponseTypeDef
- ListBlockedGuestUsersRequestPaginateTypeDef
- ListBotsRequestPaginateTypeDef
- ListDevicesForUserRequestPaginateTypeDef
- ListGuestUsersRequestPaginateTypeDef
- ListNetworksRequestPaginateTypeDef
- ListSecurityGroupUsersRequestPaginateTypeDef
- ListSecurityGroupsRequestPaginateTypeDef
- ListUsersRequestPaginateTypeDef
- ListNetworksResponseTypeDef
- NetworkSettingsTypeDef
- SecurityGroupSettingsOutputTypeDef
- SecurityGroupSettingsRequestTypeDef
- SecurityGroupSettingsTypeDef
- UpdateUserRequestTypeDef
- UpdateNetworkSettingsRequestTypeDef
- SecurityGroupTypeDef
- CreateSecurityGroupRequestTypeDef
- SecurityGroupSettingsUnionTypeDef
- CreateSecurityGroupResponseTypeDef
- GetSecurityGroupResponseTypeDef
- ListSecurityGroupsResponseTypeDef
- UpdateSecurityGroupResponseTypeDef
- UpdateSecurityGroupRequestTypeDef