You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.IVS

Inherits:
AWS.Service show all
Identifier:
ivs
API Version:
2020-07-14
Defined in:
(unknown)

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

  • Accept: application/json

  • Accept-Encoding: gzip, deflate

  • Content-Type: application/json

Resources

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

  • Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.

  • Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.

  • Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.

  • Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.

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.

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 is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.

  • Authorization is about granting permissions. You need to be authorized to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")

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 an IAM user account that has the ivs:PutMetadata permission.

For more information:

Channel Endpoints

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

  • GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).

  • BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

  • ListChannels — 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 Conflict Exception).

  • UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

  • DeleteChannel — Deletes the specified channel.

StreamKey Endpoints

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

  • GetStreamKey — Gets stream key information for the specified ARN.

  • BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

  • ListStreamKeys — Gets summary information about stream keys for the specified channel.

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

Stream Endpoints

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

  • GetStreamSession — Gets metadata on a specified stream.

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

  • ListStreamSessions — 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.

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

  • PutMetadata — 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.

PlaybackKeyPair Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

  • ImportPlaybackKeyPair — 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 (channels enabled for playback authorization).

  • GetPlaybackKeyPair — 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.

  • ListPlaybackKeyPairs — Gets summary information about playback key pairs.

  • DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.

RecordingConfiguration Endpoints

Amazon Web Services Tags Endpoints

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

  • UntagResource — Removes tags from the resource with the specified ARN.

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

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();

Version:

  • 2020-07-14

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a IVS object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.IVS.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.IVS.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IVS.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Performs GetChannel on multiple ARNs simultaneously.

Service Reference:

Examples:

Calling the batchGetChannel operation

var params = {
  arns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivs.batchGetChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arns — (Array<String>)

      Array of ARNs, one per channel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channels — (Array<map>)

        • arn — (String)

          Channel ARN.

        • authorized — (Boolean)

          Whether the channel is private (enabled for playback authorization). Default: false.

        • ingestEndpoint — (String)

          Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

        • latencyMode — (String)

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

          Possible values include:
          • "NORMAL"
          • "LOW"
        • name — (String)

          Channel name.

        • playbackUrl — (String)

          Channel playback URL.

        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • type — (String)

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

          • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

          • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

          Possible values include:
          • "BASIC"
          • "STANDARD"
      • errors — (Array<map>)

        Each error object is related to a specific ARN in the request.

        • arn — (String)

          Channel ARN.

        • code — (String)

          Error code.

        • message — (String)

          Error message, determined by the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Performs GetStreamKey on multiple ARNs simultaneously.

Service Reference:

Examples:

Calling the batchGetStreamKey operation

var params = {
  arns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivs.batchGetStreamKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arns — (Array<String>)

      Array of ARNs, one per channel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • errors — (Array<map>)

        • arn — (String)

          Channel ARN.

        • code — (String)

          Error code.

        • message — (String)

          Error message, determined by the application.

      • streamKeys — (Array<map>)

        • arn — (String)

          Stream-key ARN.

        • channelArn — (String)

          Channel ARN for the stream.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • value — (String)

          Stream-key value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  authorized: true || false,
  latencyMode: NORMAL | LOW,
  name: 'STRING_VALUE',
  recordingConfigurationArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  type: BASIC | STANDARD
};
ivs.createChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • authorized — (Boolean)

      Whether the channel is private (enabled for playback authorization). Default: false.

    • latencyMode — (String)

      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

      Possible values include:
      • "NORMAL"
      • "LOW"
    • name — (String)

      Channel name.

    • recordingConfigurationArn — (String)

      Recording-configuration ARN. Default: "" (empty string, recording is disabled).

    • tags — (map<String>)

      Array of 1-50 maps, each of the form string:string (key:value).

    • type — (String)

      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

      • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

      • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

      Possible values include:
      • "BASIC"
      • "STANDARD"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channel — (map)

        • arn — (String)

          Channel ARN.

        • authorized — (Boolean)

          Whether the channel is private (enabled for playback authorization). Default: false.

        • ingestEndpoint — (String)

          Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

        • latencyMode — (String)

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

          Possible values include:
          • "NORMAL"
          • "LOW"
        • name — (String)

          Channel name.

        • playbackUrl — (String)

          Channel playback URL.

        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • type — (String)

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

          • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

          • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

          Possible values include:
          • "BASIC"
          • "STANDARD"
      • streamKey — (map)

        • arn — (String)

          Stream-key ARN.

        • channelArn — (String)

          Channel ARN for the stream.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • value — (String)

          Stream-key value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createRecordingConfiguration operation

var params = {
  destinationConfiguration: { /* required */
    s3: {
      bucketName: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivs.createRecordingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • destinationConfiguration — (map)

      A complex type that contains a destination configuration for where recorded video will be stored.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketNamerequired — (String)

          Location (S3 bucket name) where recorded videos will be stored.

    • name — (String)

      Recording-configuration name. The value does not need to be unique.

    • tags — (map<String>)

      Array of 1-50 maps, each of the form string:string (key:value).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recordingConfiguration — (map)
        • arnrequired — (String)

          Recording-configuration ARN.

        • destinationConfigurationrequired — (map)

          A complex type that contains information about where recorded video will be stored.

          • s3 — (map)

            An S3 destination configuration where recorded videos will be stored.

            • bucketNamerequired — (String)

              Location (S3 bucket name) where recorded videos will be stored.

        • name — (String)

          Recording-configuration name. The value does not need to be unique.

        • staterequired — (String)

          Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createStreamKey operation

var params = {
  channelArn: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivs.createStreamKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      ARN of the channel for which to create the stream key.

    • tags — (map<String>)

      Array of 1-50 maps, each of the form string:string (key:value).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamKey — (map)

        Stream key used to authenticate an RTMPS stream for ingestion.

        • arn — (String)

          Stream-key ARN.

        • channelArn — (String)

          Channel ARN for the stream.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • value — (String)

          Stream-key value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Service Reference:

Examples:

Calling the deleteChannel operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.deleteChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the channel to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deletePlaybackKeyPair operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.deletePlaybackKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the key pair to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteRecordingConfiguration operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.deleteRecordingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the recording configuration to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the deleteStreamKey operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.deleteStreamKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the stream key to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the getChannel operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.getChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the channel for which the configuration is to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channel — (map)

        • arn — (String)

          Channel ARN.

        • authorized — (Boolean)

          Whether the channel is private (enabled for playback authorization). Default: false.

        • ingestEndpoint — (String)

          Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

        • latencyMode — (String)

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

          Possible values include:
          • "NORMAL"
          • "LOW"
        • name — (String)

          Channel name.

        • playbackUrl — (String)

          Channel playback URL.

        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • type — (String)

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

          • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

          • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

          Possible values include:
          • "BASIC"
          • "STANDARD"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the getPlaybackKeyPair operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.getPlaybackKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the key pair to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • keyPair — (map)
        • arn — (String)

          Key-pair ARN.

        • fingerprint — (String)

          Key-pair identifier.

        • name — (String)

          Playback-key-pair name. The value does not need to be unique.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets the recording configuration for the specified ARN.

Service Reference:

Examples:

Calling the getRecordingConfiguration operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.getRecordingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the recording configuration to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recordingConfiguration — (map)
        • arnrequired — (String)

          Recording-configuration ARN.

        • destinationConfigurationrequired — (map)

          A complex type that contains information about where recorded video will be stored.

          • s3 — (map)

            An S3 destination configuration where recorded videos will be stored.

            • bucketNamerequired — (String)

              Location (S3 bucket name) where recorded videos will be stored.

        • name — (String)

          Recording-configuration name. The value does not need to be unique.

        • staterequired — (String)

          Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the getStream operation

var params = {
  channelArn: 'STRING_VALUE' /* required */
};
ivs.getStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      Channel ARN for stream to be accessed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • stream — (map)

        • channelArn — (String)

          Channel ARN for the stream.

        • health — (String)

          The stream’s health.

          Possible values include:
          • "HEALTHY"
          • "STARVING"
          • "UNKNOWN"
        • playbackUrl — (String)

          URL of the master playlist, required by the video player to play the HLS stream.

        • startTime — (Date)

          Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

        • state — (String)

          The stream’s state.

          Possible values include:
          • "LIVE"
          • "OFFLINE"
        • streamId — (String)

          Unique identifier for a live or previously live stream in the specified channel.

        • viewerCount — (Integer)

          A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets stream-key information for a specified ARN.

Service Reference:

Examples:

Calling the getStreamKey operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivs.getStreamKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN for the stream key to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamKey — (map)
        • arn — (String)

          Stream-key ARN.

        • channelArn — (String)

          Channel ARN for the stream.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • value — (String)

          Stream-key value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets metadata on a specified stream.

Service Reference:

Examples:

Calling the getStreamSession operation

var params = {
  channelArn: 'STRING_VALUE', /* required */
  streamId: 'STRING_VALUE'
};
ivs.getStreamSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      ARN of the channel resource

    • streamId — (String)

      Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamSession — (map)

        List of stream details.

        • channel — (map)

          The properties of the channel at the time of going live.

          • arn — (String)

            Channel ARN.

          • authorized — (Boolean)

            Whether the channel is private (enabled for playback authorization). Default: false.

          • ingestEndpoint — (String)

            Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

          • latencyMode — (String)

            Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

            Possible values include:
            • "NORMAL"
            • "LOW"
          • name — (String)

            Channel name.

          • playbackUrl — (String)

            Channel playback URL.

          • recordingConfigurationArn — (String)

            Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

          • tags — (map<String>)

            Array of 1-50 maps, each of the form string:string (key:value).

          • type — (String)

            Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

            • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

            • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

            Possible values include:
            • "BASIC"
            • "STANDARD"
        • endTime — (Date)

          UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.

        • ingestConfiguration — (map)

          The properties of the incoming RTMP stream for the stream.

          • audio — (map)

            Encoder settings for audio.

            • channels — (Integer)

              Number of audio channels.

            • codec — (String)

              Codec used for the audio encoding.

            • sampleRate — (Integer)

              Number of audio samples recorded per second.

            • targetBitrate — (Integer)

              The expected ingest bitrate (bits per second). This is configured in the encoder.

          • video — (map)

            Encoder settings for video.

            • avcLevel — (String)

              Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

            • avcProfile — (String)

              Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

            • codec — (String)

              Codec used for the video encoding.

            • encoder — (String)

              Software or hardware used to encode the video.

            • targetBitrate — (Integer)

              The expected ingest bitrate (bits per second). This is configured in the encoder.

            • targetFramerate — (Integer)

              The expected ingest framerate. This is configured in the encoder.

            • videoHeight — (Integer)

              Video-resolution height in pixels.

            • videoWidth — (Integer)

              Video-resolution width in pixels.

        • recordingConfiguration — (map)

          The properties of recording the live stream.

          • arnrequired — (String)

            Recording-configuration ARN.

          • destinationConfigurationrequired — (map)

            A complex type that contains information about where recorded video will be stored.

            • s3 — (map)

              An S3 destination configuration where recorded videos will be stored.

              • bucketNamerequired — (String)

                Location (S3 bucket name) where recorded videos will be stored.

          • name — (String)

            Recording-configuration name. The value does not need to be unique.

          • staterequired — (String)

            Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

            Possible values include:
            • "CREATING"
            • "CREATE_FAILED"
            • "ACTIVE"
          • tags — (map<String>)

            Array of 1-50 maps, each of the form string:string (key:value).

        • startTime — (Date)

          UTC ISO-8601 formatted timestamp of when the channel went live.

        • streamId — (String)

          Unique identifier for a live or previously live stream in the specified channel.

        • truncatedEvents — (Array<map>)

          List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

          • eventTime — (Date)

            UTC ISO-8601 formatted timestamp of when the event occurred.

          • name — (String)

            Name that identifies the stream event within a type.

          • type — (String)

            Logical group for certain events.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the importPlaybackKeyPair operation

var params = {
  publicKeyMaterial: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivs.importPlaybackKeyPair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      Playback-key-pair name. The value does not need to be unique.

    • publicKeyMaterial — (String)

      The public portion of a customer-generated key pair.

    • tags — (map<String>)

      Any tags provided with the request are added to the playback key pair tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • keyPair — (map)

        • arn — (String)

          Key-pair ARN.

        • fingerprint — (String)

          Key-pair identifier.

        • name — (String)

          Playback-key-pair name. The value does not need to be unique.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the listChannels operation

var params = {
  filterByName: 'STRING_VALUE',
  filterByRecordingConfigurationArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterByName — (String)

      Filters the channel list to match the specified name.

    • filterByRecordingConfigurationArn — (String)

      Filters the channel list to match the specified recording-configuration ARN.

    • maxResults — (Integer)

      Maximum number of channels to return. Default: 50.

    • nextToken — (String)

      The first channel to retrieve. This is used for pagination; see the nextToken response field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channels — (Array<map>)

        List of the matching channels.

        • arn — (String)

          Channel ARN.

        • authorized — (Boolean)

          Whether the channel is private (enabled for playback authorization). Default: false.

        • latencyMode — (String)

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

          Possible values include:
          • "NORMAL"
          • "LOW"
        • name — (String)

          Channel name.

        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

      • nextToken — (String)

        If there are more channels than maxResults, use nextToken in the request to get the next set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Service Reference:

Examples:

Calling the listPlaybackKeyPairs operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listPlaybackKeyPairs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The first key pair to retrieve. This is used for pagination; see the nextToken response field. Default: 50.

    • nextToken — (String)

      Maximum number of key pairs to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • keyPairs — (Array<map>)

        List of key pairs.

        • arn — (String)

          Key-pair ARN.

        • name — (String)

          Playback-key-pair name. The value does not need to be unique.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

      • nextToken — (String)

        If there are more key pairs than maxResults, use nextToken in the request to get the next set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listRecordingConfigurations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listRecordingConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Maximum number of recording configurations to return. Default: 50.

    • nextToken — (String)

      The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

      • recordingConfigurations — (Array<map>)

        List of the matching recording configurations.

        • arnrequired — (String)

          Recording-configuration ARN.

        • destinationConfigurationrequired — (map)

          A complex type that contains information about where recorded video will be stored.

          • s3 — (map)

            An S3 destination configuration where recorded videos will be stored.

            • bucketNamerequired — (String)

              Location (S3 bucket name) where recorded videos will be stored.

        • name — (String)

          Recording-configuration name. The value does not need to be unique.

        • staterequired — (String)

          Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets summary information about stream keys for the specified channel.

Service Reference:

Examples:

Calling the listStreamKeys operation

var params = {
  channelArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listStreamKeys(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      Channel ARN used to filter the list.

    • maxResults — (Integer)

      Maximum number of streamKeys to return. Default: 50.

    • nextToken — (String)

      The first stream key to retrieve. This is used for pagination; see the nextToken response field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If there are more stream keys than maxResults, use nextToken in the request to get the next set.

      • streamKeys — (Array<map>)

        List of stream keys.

        • arn — (String)

          Stream-key ARN.

        • channelArn — (String)

          Channel ARN for the stream.

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listStreams operation

var params = {
  filterBy: {
    health: HEALTHY | STARVING | UNKNOWN
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listStreams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filterBy — (map)

      Filters the stream list to match the specified criterion.

      • health — (String)

        The stream’s health.

        Possible values include:
        • "HEALTHY"
        • "STARVING"
        • "UNKNOWN"
    • maxResults — (Integer)

      Maximum number of streams to return. Default: 50.

    • nextToken — (String)

      The first stream to retrieve. This is used for pagination; see the nextToken response field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If there are more streams than maxResults, use nextToken in the request to get the next set.

      • streams — (Array<map>)

        List of streams.

        • channelArn — (String)

          Channel ARN for the stream.

        • health — (String)

          The stream’s health.

          Possible values include:
          • "HEALTHY"
          • "STARVING"
          • "UNKNOWN"
        • startTime — (Date)

          Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

        • state — (String)

          The stream’s state.

          Possible values include:
          • "LIVE"
          • "OFFLINE"
        • streamId — (String)

          Unique identifier for a live or previously live stream in the specified channel.

        • viewerCount — (Integer)

          A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listStreamSessions operation

var params = {
  channelArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivs.listStreamSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      Channel ARN used to filter the list.

    • maxResults — (Integer)

      Maximum number of streams to return. Default: 50.

    • nextToken — (String)

      The first stream to retrieve. This is used for pagination; see the nextToken response field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If there are more streams than maxResults, use nextToken in the request to get the next set.

      • streamSessions — (Array<map>)

        • endTime — (Date)

          UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.

        • hasErrorEvent — (Boolean)

          If true, this stream encountered a quota breach or failure.

        • startTime — (Date)

          UTC ISO-8601 formatted timestamp of when the channel went live.

        • streamId — (String)

          Unique identifier for a live or previously live stream in the specified channel.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ivs.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the putMetadata operation

var params = {
  channelArn: 'STRING_VALUE', /* required */
  metadata: 'STRING_VALUE' /* required */
};
ivs.putMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      ARN of the channel into which metadata is inserted. This channel must have an active stream.

    • metadata — (String)

      Metadata to insert into the stream. Maximum: 1 KB per request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the stopStream operation

var params = {
  channelArn: 'STRING_VALUE' /* required */
};
ivs.stopStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelArn — (String)

      ARN of the channel for which the stream is to be stopped.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivs.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      ARN of the resource for which tags are to be added or updated.

    • tags — (map<String>)

      Array of tags to be added or updated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from the resource with the specified ARN.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivs.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      ARN of the resource for which tags are to be removed.

    • tagKeys — (Array<String>)

      Array of tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  arn: 'STRING_VALUE', /* required */
  authorized: true || false,
  latencyMode: NORMAL | LOW,
  name: 'STRING_VALUE',
  recordingConfigurationArn: 'STRING_VALUE',
  type: BASIC | STANDARD
};
ivs.updateChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      ARN of the channel to be updated.

    • authorized — (Boolean)

      Whether the channel is private (enabled for playback authorization).

    • latencyMode — (String)

      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

      Possible values include:
      • "NORMAL"
      • "LOW"
    • name — (String)

      Channel name.

    • recordingConfigurationArn — (String)

      Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

    • type — (String)

      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

      • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

      • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

      Possible values include:
      • "BASIC"
      • "STANDARD"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channel — (map)

        Object specifying a channel.

        • arn — (String)

          Channel ARN.

        • authorized — (Boolean)

          Whether the channel is private (enabled for playback authorization). Default: false.

        • ingestEndpoint — (String)

          Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

        • latencyMode — (String)

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

          Possible values include:
          • "NORMAL"
          • "LOW"
        • name — (String)

          Channel name.

        • playbackUrl — (String)

          Channel playback URL.

        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

        • tags — (map<String>)

          Array of 1-50 maps, each of the form string:string (key:value).

        • type — (String)

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

          • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

          • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

          Possible values include:
          • "BASIC"
          • "STANDARD"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.