@aws-sdk/client-ivschat

Description

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

Introduction

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat
resources. You also need to integrate with the Amazon IVS Chat Messaging
API, to enable users to interact with chat rooms in real time.

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the
AWS General Reference.

This document describes HTTP operations. There is a separate messaging API
for managing Chat resources; see the Amazon IVS Chat Messaging API
Reference.

Notes on terminology:

• 
  

  You create service applications using the Amazon IVS Chat API. We refer to these as
  applications.

  
  


• 
  

  You create front-end client applications (browser and Android/iOS apps) using the
  Amazon IVS Chat Messaging API. We refer to these as clients.

  
  

Resources

The following resources are part of Amazon IVS Chat:

• 
  

  
  LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.

  
  


• 
  

  
  Room — The central Amazon IVS Chat resource through
  which clients connect to and exchange chat messages. See the Room endpoints for more
  information.

  
  

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag
comprises a key and a value, both set by you. For
example, you might set a tag as topic:nature to label a particular video
category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific
constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the
same tag for different resources to indicate that they are related. You can also use tags to
manage access (see Access Tags).

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and
ListTagsForResource. The following resource supports tagging: Room.

At most 50 tags can be applied to a resource.

API Access Security

Your Amazon IVS Chat applications (service applications and clients) must be authenticated
and authorized to access Amazon IVS Chat resources. Note the differences between these
concepts:

• 
  

  
  Authentication is about verifying identity. Requests to the
  Amazon IVS Chat API must be signed to verify your identity.

  
  


• 
  

  
  Authorization is about granting permissions. Your IAM roles need
  to have permissions for Amazon IVS Chat API requests.

  
  

Users (viewers) connect to a room using secure access tokens that you create using the
CreateChatToken operation through the AWS SDK. You call CreateChatToken for
every user’s chat session, passing identity and authorization information about the
user.

Signing API Requests

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security
credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the
underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API
directly, it’s your responsibility to sign the requests.

You generate a signature using valid AWS credentials for an IAM role that has permission
to perform the requested action. For example, DeleteMessage requests must be made using an IAM
role that has the ivschat:DeleteMessage permission.

For more information:

• 
  

  Authentication and generating signatures — See Authenticating Requests
  (Amazon Web Services Signature Version 4) in the Amazon Web Services
  General Reference.

  
  


• 
  

  Managing Amazon IVS permissions — See Identity and Access Management on
  the Security page of the Amazon IVS User Guide.

  
  

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a
resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
information, see Amazon Resource Names in the AWS General
Reference.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { IvschatClient, ListRoomsCommand } = require("@aws-sdk/client-ivschat");
`

`ts
// ES6+ example
import { IvschatClient, ListRoomsCommand } from "@aws-sdk/client-ivschat";
`

$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 IvschatClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListRoomsCommand(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-ivschat";
const client = new AWS.Ivschat({ region: "REGION" });

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

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

// callbacks.
client.listRooms(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-ivschat` 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)

CreateChatToken

Command API Reference / Input / Output

CreateLoggingConfiguration

Command API Reference / Input / Output

CreateRoom

Command API Reference / Input / Output

DeleteLoggingConfiguration

Command API Reference / Input / Output

DeleteMessage

Command API Reference / Input / Output

DeleteRoom

Command API Reference / Input / Output

DisconnectUser

Command API Reference / Input / Output

GetLoggingConfiguration

Command API Reference / Input / Output

GetRoom

Command API Reference / Input / Output

ListLoggingConfigurations

Command API Reference / Input / Output

ListRooms

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

SendEvent

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateLoggingConfiguration

Command API Reference / Input / Output

UpdateRoom

Command API Reference / Input / Output