We are excited to announce our new API Documentation.
AWS SDK for JavaScript KinesisVideo Client for Node.js, Browser and React Native.
To install the this package, simply type add or install @aws-sdk/client-kinesis-video using your favorite package manager:
npm install @aws-sdk/client-kinesis-videoyarn add @aws-sdk/client-kinesis-videopnpm add @aws-sdk/client-kinesis-videoThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the KinesisVideoClient and
the commands you need, for example ListStreamsCommand:
// ES5 example
const { KinesisVideoClient, ListStreamsCommand } = require("@aws-sdk/client-kinesis-video");
// ES6+ example
import { KinesisVideoClient, ListStreamsCommand } from "@aws-sdk/client-kinesis-video";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new KinesisVideoClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListStreamsCommand(params);
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.
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.
});
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.
});
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-kinesis-video";
const client = new AWS.KinesisVideo({ region: "REGION" });
// async/await.
try {
const data = await client.listStreams(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listStreams(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listStreams(params, (err, data) => {
// process err and data.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-kinesis-video package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.