@aws-sdk/client-wickr

Description

AWS SDK for JavaScript Wickr Client for Node.js, Browser and React Native.

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.

1. Client errors are indicated by HTTP Status Code class of 4xx

2. 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.

Installing

To install this package, simply type add or install @aws-sdk/client-wickr
using your favorite package manager:
- npm install @aws-sdk/client-wickr
- yarn add @aws-sdk/client-wickr
- pnpm add @aws-sdk/client-wickr

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the WickrClient and
the commands you need, for example ListBotsCommand:

``js
// ES5 example
const { WickrClient, ListBotsCommand } = require("@aws-sdk/client-wickr");
`

`ts
// ES6+ example
import { WickrClient, ListBotsCommand } from "@aws-sdk/client-wickr";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new WickrClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListBotsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-wickr";
const client = new AWS.Wickr({ region: "REGION" });

// async/await.
try {
const data = await client.listBots(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listBots(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listBots(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-wickr` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

BatchCreateUser

Command API Reference / Input / Output

BatchDeleteUser

Command API Reference / Input / Output

BatchLookupUserUname

Command API Reference / Input / Output

BatchReinviteUser

Command API Reference / Input / Output

BatchResetDevicesForUser

Command API Reference / Input / Output

BatchToggleUserSuspendStatus

Command API Reference / Input / Output

CreateBot

Command API Reference / Input / Output

CreateDataRetentionBot

Command API Reference / Input / Output

CreateDataRetentionBotChallenge

Command API Reference / Input / Output

CreateNetwork

Command API Reference / Input / Output

CreateSecurityGroup

Command API Reference / Input / Output

DeleteBot

Command API Reference / Input / Output

DeleteDataRetentionBot

Command API Reference / Input / Output

DeleteNetwork

Command API Reference / Input / Output

DeleteSecurityGroup

Command API Reference / Input / Output

GetBot

Command API Reference / Input / Output

GetBotsCount

Command API Reference / Input / Output

GetDataRetentionBot

Command API Reference / Input / Output

GetGuestUserHistoryCount

Command API Reference / Input / Output

GetNetwork

Command API Reference / Input / Output

GetNetworkSettings

Command API Reference / Input / Output

GetOidcInfo

Command API Reference / Input / Output

GetSecurityGroup

Command API Reference / Input / Output

GetUser

Command API Reference / Input / Output

GetUsersCount

Command API Reference / Input / Output

ListBlockedGuestUsers

Command API Reference / Input / Output

ListBots

Command API Reference / Input / Output

ListDevicesForUser

Command API Reference / Input / Output

ListGuestUsers

Command API Reference / Input / Output

ListNetworks

Command API Reference / Input / Output

ListSecurityGroups

Command API Reference / Input / Output

ListSecurityGroupUsers

Command API Reference / Input / Output

ListUsers

Command API Reference / Input / Output

RegisterOidcConfig

Command API Reference / Input / Output

RegisterOidcConfigTest

Command API Reference / Input / Output

UpdateBot

Command API Reference / Input / Output

UpdateDataRetention

Command API Reference / Input / Output

UpdateGuestUser

Command API Reference / Input / Output

UpdateNetwork

Command API Reference / Input / Output

UpdateNetworkSettings

Command API Reference / Input / Output

UpdateSecurityGroup

Command API Reference / Input / Output

UpdateUser

Command API Reference / Input / Output