AWS.IVS — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.IVS

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Introduction

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

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

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

Key Concepts

For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.

Tagging

A tag is a metadata label that you assign to an Amazon Web Services 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 Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your Amazon Web Services 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 API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.

For more information:

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.

Sending a Request Using IVS

var ivs = new AWS.IVS();
ivs.batchGetChannel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IVS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ivs = new AWS.IVS({apiVersion: '2020-07-14'});

You can also set the API version globally in AWS.config.apiVersions using the ivs service identifier:

AWS.config.apiVersions = {
  ivs: '2020-07-14',
  // other service API versions
};

var ivs = new AWS.IVS();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IVS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetChannel(params = {}, callback) ⇒ AWS.Request

Performs GetChannel on multiple ARNs simultaneously.

batchGetStreamKey(params = {}, callback) ⇒ AWS.Request

batchStartViewerSessionRevocation(params = {}, callback) ⇒ AWS.Request

createChannel(params = {}, callback) ⇒ AWS.Request

Creates a new channel and an associated stream key to start streaming.

createPlaybackRestrictionPolicy(params = {}, callback) ⇒ AWS.Request

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

createRecordingConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

createStreamKey(params = {}, callback) ⇒ AWS.Request

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

deleteChannel(params = {}, callback) ⇒ AWS.Request

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

deletePlaybackKeyPair(params = {}, callback) ⇒ AWS.Request

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

deletePlaybackRestrictionPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the specified playback restriction policy.

deleteRecordingConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

deleteStreamKey(params = {}, callback) ⇒ AWS.Request

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

getChannel(params = {}, callback) ⇒ AWS.Request

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

getPlaybackKeyPair(params = {}, callback) ⇒ AWS.Request

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

getPlaybackRestrictionPolicy(params = {}, callback) ⇒ AWS.Request

Gets the specified playback restriction policy.

getRecordingConfiguration(params = {}, callback) ⇒ AWS.Request

Gets the recording configuration for the specified ARN.

getStream(params = {}, callback) ⇒ AWS.Request

Gets information about the active (live) stream on a specified channel.

getStreamKey(params = {}, callback) ⇒ AWS.Request

Gets stream-key information for a specified ARN.

getStreamSession(params = {}, callback) ⇒ AWS.Request

Gets metadata on a specified stream.

importPlaybackKeyPair(params = {}, callback) ⇒ AWS.Request

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

listChannels(params = {}, callback) ⇒ AWS.Request

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

listPlaybackKeyPairs(params = {}, callback) ⇒ AWS.Request

listPlaybackRestrictionPolicies(params = {}, callback) ⇒ AWS.Request

Gets summary information about playback restriction policies.

listRecordingConfigurations(params = {}, callback) ⇒ AWS.Request

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

listStreamKeys(params = {}, callback) ⇒ AWS.Request

Gets summary information about stream keys for the specified channel.

listStreams(params = {}, callback) ⇒ AWS.Request

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

listStreamSessions(params = {}, callback) ⇒ AWS.Request

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Gets information about Amazon Web Services tags for the specified ARN.

putMetadata(params = {}, callback) ⇒ AWS.Request

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

startViewerSessionRevocation(params = {}, callback) ⇒ AWS.Request

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

stopStream(params = {}, callback) ⇒ AWS.Request

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Note: Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the resource with the specified ARN.

updateChannel(params = {}, callback) ⇒ AWS.Request

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

updatePlaybackRestrictionPolicy(params = {}, callback) ⇒ AWS.Request

Updates a specified playback restriction policy.