@aws-sdk/client-ivs-realtime

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-ivs-realtime

Description

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

Introduction

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

Terminology:

A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID There is a 1:1 mapping between participant tokens and participants.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

Stage — A stage is a virtual space where participants can exchange video in real time.

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 Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages 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 real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.

Tags Endpoints

ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.

Installing

To install the this package, simply type add or install @aws-sdk/client-ivs-realtime using your favorite package manager:

npm install @aws-sdk/client-ivs-realtime
yarn add @aws-sdk/client-ivs-realtime
pnpm add @aws-sdk/client-ivs-realtime

Getting Started

Import

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

// ES5 example
const { IVSRealTimeClient, ListStagesCommand } = require("@aws-sdk/client-ivs-realtime");

// ES6+ example
import { IVSRealTimeClient, ListStagesCommand } from "@aws-sdk/client-ivs-realtime";

Usage

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.

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

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

Async/await

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

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

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

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

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.

// 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

import * as AWS from "@aws-sdk/client-ivs-realtime";
const client = new AWS.IVSRealTime({ region: "REGION" });

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

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

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

Troubleshooting

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

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.