Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-medialive

@aws-sdk/client-medialive

Description

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

API for AWS Elemental MediaLive

Installing

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

  • npm install @aws-sdk/client-medialive
  • yarn add @aws-sdk/client-medialive
  • pnpm add @aws-sdk/client-medialive

Getting Started

Import

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

// ES5 example
const { MediaLiveClient, ListInputsCommand } = require("@aws-sdk/client-medialive");
// ES6+ example
import { MediaLiveClient, ListInputsCommand } from "@aws-sdk/client-medialive";

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

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

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

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

// callbacks.
client.listInputs(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.

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-medialive 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)

AcceptInputDeviceTransfer

Command API Reference / Input / Output

BatchDelete

Command API Reference / Input / Output

BatchStart

Command API Reference / Input / Output

BatchStop

Command API Reference / Input / Output

BatchUpdateSchedule

Command API Reference / Input / Output

CancelInputDeviceTransfer

Command API Reference / Input / Output

ClaimDevice

Command API Reference / Input / Output

CreateChannel

Command API Reference / Input / Output

CreateInput

Command API Reference / Input / Output

CreateInputSecurityGroup

Command API Reference / Input / Output

CreateMultiplex

Command API Reference / Input / Output

CreateMultiplexProgram

Command API Reference / Input / Output

CreatePartnerInput

Command API Reference / Input / Output

CreateTags

Command API Reference / Input / Output

DeleteChannel

Command API Reference / Input / Output

DeleteInput

Command API Reference / Input / Output

DeleteInputSecurityGroup

Command API Reference / Input / Output

DeleteMultiplex

Command API Reference / Input / Output

DeleteMultiplexProgram

Command API Reference / Input / Output

DeleteReservation

Command API Reference / Input / Output

DeleteSchedule

Command API Reference / Input / Output

DeleteTags

Command API Reference / Input / Output

DescribeAccountConfiguration

Command API Reference / Input / Output

DescribeChannel

Command API Reference / Input / Output

DescribeInput

Command API Reference / Input / Output

DescribeInputDevice

Command API Reference / Input / Output

DescribeInputDeviceThumbnail

Command API Reference / Input / Output

DescribeInputSecurityGroup

Command API Reference / Input / Output

DescribeMultiplex

Command API Reference / Input / Output

DescribeMultiplexProgram

Command API Reference / Input / Output

DescribeOffering

Command API Reference / Input / Output

DescribeReservation

Command API Reference / Input / Output

DescribeSchedule

Command API Reference / Input / Output

DescribeThumbnails

Command API Reference / Input / Output

ListChannels

Command API Reference / Input / Output

ListInputDevices

Command API Reference / Input / Output

ListInputDeviceTransfers

Command API Reference / Input / Output

ListInputs

Command API Reference / Input / Output

ListInputSecurityGroups

Command API Reference / Input / Output

ListMultiplexes

Command API Reference / Input / Output

ListMultiplexPrograms

Command API Reference / Input / Output

ListOfferings

Command API Reference / Input / Output

ListReservations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PurchaseOffering

Command API Reference / Input / Output

RebootInputDevice

Command API Reference / Input / Output

RejectInputDeviceTransfer

Command API Reference / Input / Output

StartChannel

Command API Reference / Input / Output

StartInputDevice

Command API Reference / Input / Output

StartInputDeviceMaintenanceWindow

Command API Reference / Input / Output

StartMultiplex

Command API Reference / Input / Output

StopChannel

Command API Reference / Input / Output

StopInputDevice

Command API Reference / Input / Output

StopMultiplex

Command API Reference / Input / Output

TransferInputDevice

Command API Reference / Input / Output

UpdateAccountConfiguration

Command API Reference / Input / Output

UpdateChannel

Command API Reference / Input / Output

UpdateChannelClass

Command API Reference / Input / Output

UpdateInput

Command API Reference / Input / Output

UpdateInputDevice

Command API Reference / Input / Output

UpdateInputSecurityGroup

Command API Reference / Input / Output

UpdateMultiplex

Command API Reference / Input / Output

UpdateMultiplexProgram

Command API Reference / Input / Output

UpdateReservation

Command API Reference / Input / Output