Class: AWS.IVS

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 stream key.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • value — (String)

        Stream-key value.

Returns:

• (AWS.Request) —

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

var params = {
  authorized: true || false,
  insecureIngest: 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.

  • insecureIngest — (Boolean)

    Whether the channel allows insecure RTMP ingest. 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). 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.

  • 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

    • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

    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.

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. 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.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

        • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

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

        Stream-key ARN.

      • channelArn — (String)

        Channel ARN for the stream.

      • tags — (map<String>)

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • value — (String)

        Stream-key value.

Returns:

• (AWS.Request) —

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

var params = {
  destinationConfiguration: { /* required */
    s3: {
      bucketName: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE',
  recordingReconnectWindowSeconds: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  thumbnailConfiguration: {
    recordingMode: DISABLED | INTERVAL,
    targetIntervalSeconds: 'NUMBER_VALUE'
  }
};
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.

      • bucketName — required — (String)

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

  • name — (String)

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

  • recordingReconnectWindowSeconds — (Integer)

    If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

  • tags — (map<String>)

    Array of 1-50 maps, each of the form string:string (key:value). 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.

  • thumbnailConfiguration — (map)

    A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

    • recordingMode — (String)

      Thumbnail recording mode. Default: INTERVAL.

      Possible values include:
      • "DISABLED"
      • "INTERVAL"
    • targetIntervalSeconds — (Integer)

      The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

      Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

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)
      • arn — required — (String)

        Recording-configuration ARN.

      • destinationConfiguration — required — (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.

          • bucketName — required — (String)

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

      • name — (String)

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

      • recordingReconnectWindowSeconds — (Integer)

        If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

      • state — required — (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>)

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • thumbnailConfiguration — (map)

        A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

        • recordingMode — (String)

          Thumbnail recording mode. Default: INTERVAL.

          Possible values include:
          • "DISABLED"
          • "INTERVAL"
        • targetIntervalSeconds — (Integer)

          The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

          Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Returns:

• (AWS.Request) —

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

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

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • value — (String)

        Stream-key value.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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.

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. 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.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

        • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

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

Returns:

• (AWS.Request) —

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

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

Returns:

• (AWS.Request) —

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

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)
      • arn — required — (String)

        Recording-configuration ARN.

      • destinationConfiguration — required — (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.

          • bucketName — required — (String)

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

      • name — (String)

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

      • recordingReconnectWindowSeconds — (Integer)

        If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

      • state — required — (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>)

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • thumbnailConfiguration — (map)

        A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

        • recordingMode — (String)

          Thumbnail recording mode. Default: INTERVAL.

          Possible values include:
          • "DISABLED"
          • "INTERVAL"
        • targetIntervalSeconds — (Integer)

          The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

          Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Returns:

• (AWS.Request) —

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

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; note that this is returned as a string.

      • state — (String)

        The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

        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.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • value — (String)

        Stream-key value.

Returns:

• (AWS.Request) —

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

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.

        • insecureIngest — (Boolean)

          Whether the channel allows insecure RTMP ingest. 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.

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

          Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

        • 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

          • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

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

        Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. 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.

        • arn — required — (String)

          Recording-configuration ARN.

        • destinationConfiguration — required — (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.

            • bucketName — required — (String)

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

        • name — (String)

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

        • recordingReconnectWindowSeconds — (Integer)

          If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

        • state — required — (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>)

          Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

        • thumbnailConfiguration — (map)

          A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

          • recordingMode — (String)

            Thumbnail recording mode. Default: INTERVAL.

            Possible values include:
            • "DISABLED"
            • "INTERVAL"
          • targetIntervalSeconds — (Integer)

            The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

            Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

      • startTime — (Date)

        Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

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

          Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

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

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

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

Returns:

• (AWS.Request) —

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

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: 100.

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

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. 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>)

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

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

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)

    Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

  • nextToken — (String)

    The first key pair 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:

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

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

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: your service quota or 100, whichever is smaller.

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

      • arn — required — (String)

        Recording-configuration ARN.

      • destinationConfiguration — required — (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.

          • bucketName — required — (String)

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

      • name — (String)

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

      • state — required — (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>)

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

Returns:

• (AWS.Request) —

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

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: 1.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

Returns:

• (AWS.Request) —

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

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: 100.

  • 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; note that this is returned as a string.

      • state — (String)

        The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

        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.

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: 100.

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

      List of stream sessions.

      • endTime — (Date)

        Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

      • hasErrorEvent — (Boolean)

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

      • startTime — (Date)

        Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

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

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. The ARN must be URL-encoded.

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

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

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.

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.

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. The ARN must be URL-encoded.

  • tags — (map<String>)

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). 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.

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.

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. The ARN must be URL-encoded.

  • tagKeys — (Array<String>)

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). 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.

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.

var params = {
  arn: 'STRING_VALUE', /* required */
  authorized: true || false,
  insecureIngest: 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).

  • insecureIngest — (Boolean)

    Whether the channel allows insecure RTMP ingest. 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.)

    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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

    • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

    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.

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. 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.

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

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). 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.

      • 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

        • BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

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

Returns:

• (AWS.Request) —

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