Welcome

Welcome to the AWS Wickr API Reference.

The AWS Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing AWS Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the AWS Wickr API, including operations, types, inputs and outputs, and error codes. You can use an AWS SDK, the AWS Command Line Interface (AWS CLI, or the REST API to make API calls for AWS Wickr.

Using AWS SDK

The SDK clients authenticate your requests by using access keys that you provide. For more information, see Authentication and access using AWS SDKs and tools in the AWS SDKs and Tools Reference Guide.

Using AWS CLI

Use your access keys with the AWS CLI to make API calls. For more information about setting up the AWS CLI, see Getting started with the AWS CLI in the AWS 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. AWS Wickr supports Signature Version 4. For more information, see AWS Signature Version 4 for API requests in the AWS Identity and Access Management User Guide.

Access and permissions to the APIs can be controlled by AWS Identity and Access Management. The managed policy AWSWickrFullAccess grants full administrative permission to the AWS Wickr service APIs. For more information on restricting access to specific operations, see Identity and access management for AWS Wickr in the AWS Wickr Administration Guide.

Types of Errors:

The AWS Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.

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.

This document was last published on December 22, 2025.