WickrAdminAPI¶
Client¶
- class WickrAdminAPI.Client¶
A low-level client representing AWS Wickr Admin API
Welcome to the Amazon Web Services Wickr API Reference.
The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr.
Using Amazon Web Services SDK
The SDK clients authenticate your requests by using access keys that you provide. For more information, see Authentication and access using Amazon Web Services SDKs and tools in the Amazon Web Services SDKs and Tools Reference Guide.
Using Amazon Web Services CLI
Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see Getting started with the Amazon Web Services CLI in the Amazon Web Services Command Line Interface User Guide for Version 2.
Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API requests in the Amazon Web Services Identity and Access Management User Guide.
Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy Amazon Web ServicesWickrFullAccess grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see Identity and access management for Amazon Web Services Wickr in the Amazon Web Services Wickr Administration Guide.
Types of Errors:
The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.
Client errors are indicated by HTTP Status Code class of 4xx
Service errors are indicated by HTTP Status Code class of 5xx
In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.
client = session.create_client('wickr')
These are the available methods:
- batch_create_user
- batch_delete_user
- batch_lookup_user_uname
- batch_reinvite_user
- batch_reset_devices_for_user
- batch_toggle_user_suspend_status
- can_paginate
- close
- create_bot
- create_data_retention_bot
- create_data_retention_bot_challenge
- create_network
- create_security_group
- delete_bot
- delete_data_retention_bot
- delete_network
- delete_security_group
- get_bot
- get_bots_count
- get_data_retention_bot
- get_guest_user_history_count
- get_network
- get_network_settings
- get_oidc_info
- get_paginator
- get_security_group
- get_user
- get_users_count
- get_waiter
- list_blocked_guest_users
- list_bots
- list_devices_for_user
- list_guest_users
- list_networks
- list_security_group_users
- list_security_groups
- list_users
- register_oidc_config
- register_oidc_config_test
- update_bot
- update_data_retention
- update_guest_user
- update_network
- update_network_settings
- update_security_group
- update_user
Client Exceptions¶
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators¶
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: