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:

    • streamKeys — (Array<map>)
      • arn — (String)

        Stream-key ARN.

      • value — (String)

        Stream-key value.

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

    • errors — (Array<map>)
      • arn — (String)

        ARN of an IVS resource; e.g., channel.

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

var params = {
  viewerSessions: [ /* required */
    {
      channelArn: 'STRING_VALUE', /* required */
      viewerId: 'STRING_VALUE', /* required */
      viewerSessionVersionsLessThanOrEqualTo: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
ivs.batchStartViewerSessionRevocation(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: {}) —
  • viewerSessions — (Array<map>)

    Array of viewer sessions, one per channel-ARN and viewer-ID pair.

    • channelArn — required — (String)

      The ARN of the channel associated with the viewer session to revoke.

    • viewerId — required — (String)

      The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

    • viewerSessionVersionsLessThanOrEqualTo — (Integer)

      An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

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

      Each error object is related to a specific channelArn and viewerId pair in the request.

      • channelArn — required — (String)

        Channel ARN.

      • viewerId — required — (String)

        The ID of the viewer session to revoke.

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

var params = {
  authorized: true || false,
  insecureIngest: true || false,
  latencyMode: NORMAL | LOW,
  name: 'STRING_VALUE',
  playbackRestrictionPolicyArn: 'STRING_VALUE',
  preset: HIGHER_BANDWIDTH_DELIVERY | CONSTRAINED_BANDWIDTH_DELIVERY,
  recordingConfigurationArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  type: BASIC | STANDARD | ADVANCED_SD | ADVANCED_HD
};
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: {}) —
  • name — (String)

    Channel name.

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

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

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

    Possible values include:
    • "BASIC"
    • "STANDARD"
    • "ADVANCED_SD"
    • "ADVANCED_HD"
  • authorized — (Boolean)

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

  • recordingConfigurationArn — (String)

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. 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.

  • insecureIngest — (Boolean)

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

  • preset — (String)

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

    Possible values include:
    • "HIGHER_BANDWIDTH_DELIVERY"
    • "CONSTRAINED_BANDWIDTH_DELIVERY"
  • playbackRestrictionPolicyArn — (String)

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

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.

      • name — (String)

        Channel name.

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

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

        Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

        Possible values include:
        • "BASIC"
        • "STANDARD"
        • "ADVANCED_SD"
        • "ADVANCED_HD"
      • recordingConfigurationArn — (String)

        Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

      • ingestEndpoint — (String)

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

      • playbackUrl — (String)

        Channel playback URL.

      • authorized — (Boolean)

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

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

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. Default: false.

      • preset — (String)

        Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

        Possible values include:
        • "HIGHER_BANDWIDTH_DELIVERY"
        • "CONSTRAINED_BANDWIDTH_DELIVERY"
      • srt — (map)

        Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

        • endpoint — (String)

          The endpoint to be used when streaming with IVS using the SRT protocol.

        • passphrase — (String)

          Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.

      • playbackRestrictionPolicyArn — (String)

        Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

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

        Stream-key ARN.

      • value — (String)

        Stream-key value.

      • 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 = {
  allowedCountries: [
    'STRING_VALUE',
    /* more items */
  ],
  allowedOrigins: [
    'STRING_VALUE',
    /* more items */
  ],
  enableStrictOriginEnforcement: true || false,
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivs.createPlaybackRestrictionPolicy(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: {}) —
  • allowedCountries — (Array<String>)

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

  • allowedOrigins — (Array<String>)

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

  • enableStrictOriginEnforcement — (Boolean)

    Whether channel playback is constrained by origin site. Default: false.

  • name — (String)

    Playback-restriction-policy 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). 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:

    • playbackRestrictionPolicy — (map)
      • arn — required — (String)

        Playback-restriction-policy ARN

      • allowedCountries — required — (Array<String>)

        A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

      • allowedOrigins — required — (Array<String>)

        A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

      • enableStrictOriginEnforcement — (Boolean)

        Whether channel playback is constrained by origin site. Default: false.

      • name — (String)

        Playback-restriction-policy 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 = {
  destinationConfiguration: { /* required */
    s3: {
      bucketName: 'STRING_VALUE' /* required */
    }
  },
  name: 'STRING_VALUE',
  recordingReconnectWindowSeconds: 'NUMBER_VALUE',
  renditionConfiguration: {
    renditionSelection: ALL | NONE | CUSTOM,
    renditions: [
      SD | HD | FULL_HD | LOWEST_RESOLUTION,
      /* more items */
    ]
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  thumbnailConfiguration: {
    recordingMode: DISABLED | INTERVAL,
    resolution: SD | HD | FULL_HD | LOWEST_RESOLUTION,
    storage: [
      SEQUENTIAL | LATEST,
      /* more items */
    ],
    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: {}) —
  • name — (String)

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

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

  • 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: For the BASIC channel type, 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.

    • resolution — (String)

      Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

      Possible values include:
      • "SD"
      • "HD"
      • "FULL_HD"
      • "LOWEST_RESOLUTION"
    • storage — (Array<String>)

      Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

  • renditionConfiguration — (map)

    Object that describes which renditions should be recorded for a stream.

    • renditionSelection — (String)

      Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

      Possible values include:
      • "ALL"
      • "NONE"
      • "CUSTOM"
    • renditions — (Array<String>)

      Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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.

      • name — (String)

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

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

      • 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: For the BASIC channel type, 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.

        • resolution — (String)

          Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

          Possible values include:
          • "SD"
          • "HD"
          • "FULL_HD"
          • "LOWEST_RESOLUTION"
        • storage — (Array<String>)

          Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

      • renditionConfiguration — (map)

        Object that describes which renditions should be recorded for a stream.

        • renditionSelection — (String)

          Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

          Possible values include:
          • "ALL"
          • "NONE"
          • "CUSTOM"
        • renditions — (Array<String>)

          Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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.

      • value — (String)

        Stream-key value.

      • 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 = {
  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.deletePlaybackRestrictionPolicy(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 playback restriction policy 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.

      • name — (String)

        Channel name.

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

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

        Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

        Possible values include:
        • "BASIC"
        • "STANDARD"
        • "ADVANCED_SD"
        • "ADVANCED_HD"
      • recordingConfigurationArn — (String)

        Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

      • ingestEndpoint — (String)

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

      • playbackUrl — (String)

        Channel playback URL.

      • authorized — (Boolean)

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

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

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. Default: false.

      • preset — (String)

        Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

        Possible values include:
        • "HIGHER_BANDWIDTH_DELIVERY"
        • "CONSTRAINED_BANDWIDTH_DELIVERY"
      • srt — (map)

        Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

        • endpoint — (String)

          The endpoint to be used when streaming with IVS using the SRT protocol.

        • passphrase — (String)

          Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.

      • playbackRestrictionPolicyArn — (String)

        Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

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.

      • name — (String)

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

      • fingerprint — (String)

        Key-pair identifier.

      • 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.getPlaybackRestrictionPolicy(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 playback restriction policy 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:

    • playbackRestrictionPolicy — (map)
      • arn — required — (String)

        Playback-restriction-policy ARN

      • allowedCountries — required — (Array<String>)

        A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

      • allowedOrigins — required — (Array<String>)

        A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

      • enableStrictOriginEnforcement — (Boolean)

        Whether channel playback is constrained by origin site. Default: false.

      • name — (String)

        Playback-restriction-policy 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.

      • name — (String)

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

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

      • 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: For the BASIC channel type, 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.

        • resolution — (String)

          Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

          Possible values include:
          • "SD"
          • "HD"
          • "FULL_HD"
          • "LOWEST_RESOLUTION"
        • storage — (Array<String>)

          Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

      • renditionConfiguration — (map)

        Object that describes which renditions should be recorded for a stream.

        • renditionSelection — (String)

          Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

          Possible values include:
          • "ALL"
          • "NONE"
          • "CUSTOM"
        • renditions — (Array<String>)

          Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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.

      • streamId — (String)

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

      • 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"
      • health — (String)

        The stream’s health.

        Possible values include:
        • "HEALTHY"
        • "STARVING"
        • "UNKNOWN"
      • 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.

      • value — (String)

        Stream-key value.

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

      • streamId — (String)

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

      • startTime — (Date)

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

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

      • channel — (map)

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

        • arn — (String)

          Channel ARN.

        • name — (String)

          Channel name.

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

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

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

          Possible values include:
          • "BASIC"
          • "STANDARD"
          • "ADVANCED_SD"
          • "ADVANCED_HD"
        • recordingConfigurationArn — (String)

          Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

        • ingestEndpoint — (String)

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

        • playbackUrl — (String)

          Channel playback URL.

        • authorized — (Boolean)

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

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

        • insecureIngest — (Boolean)

          Whether the channel allows insecure RTMP ingest. Default: false.

        • preset — (String)

          Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

          Possible values include:
          • "HIGHER_BANDWIDTH_DELIVERY"
          • "CONSTRAINED_BANDWIDTH_DELIVERY"
        • srt — (map)

          Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

          • endpoint — (String)

            The endpoint to be used when streaming with IVS using the SRT protocol.

          • passphrase — (String)

            Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.

        • playbackRestrictionPolicyArn — (String)

          Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

      • ingestConfiguration — (map)

        The properties of the incoming RTMP stream for the stream.

        • video — (map)

          Encoder settings for video.

          • avcProfile — (String)

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

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

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

        • audio — (map)

          Encoder settings for audio.

          • codec — (String)

            Codec used for the audio encoding.

          • targetBitrate — (Integer)

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

          • sampleRate — (Integer)

            Number of audio samples recorded per second.

          • channels — (Integer)

            Number of audio channels.

      • recordingConfiguration — (map)

        The properties of recording the live stream.

        • arn — required — (String)

          Recording-configuration ARN.

        • name — (String)

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

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

        • 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: For the BASIC channel type, 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.

          • resolution — (String)

            Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

            Possible values include:
            • "SD"
            • "HD"
            • "FULL_HD"
            • "LOWEST_RESOLUTION"
          • storage — (Array<String>)

            Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

        • renditionConfiguration — (map)

          Object that describes which renditions should be recorded for a stream.

          • renditionSelection — (String)

            Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

            Possible values include:
            • "ALL"
            • "NONE"
            • "CUSTOM"
          • renditions — (Array<String>)

            Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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

        • name — (String)

          Name that identifies the stream event within a type.

        • type — (String)

          Logical group for certain events.

        • eventTime — (Date)

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

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: {}) —
  • publicKeyMaterial — (String)

    The public portion of a customer-generated key pair.

  • name — (String)

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

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

      • name — (String)

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

      • fingerprint — (String)

        Key-pair identifier.

      • 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',
  filterByPlaybackRestrictionPolicyArn: '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.

  • filterByPlaybackRestrictionPolicyArn — (String)

    Filters the channel list to match the specified policy.

  • nextToken — (String)

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

  • maxResults — (Integer)

    Maximum number of channels to return. Default: 100.

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.

      • name — (String)

        Channel name.

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

        Possible values include:
        • "NORMAL"
        • "LOW"
      • authorized — (Boolean)

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

      • recordingConfigurationArn — (String)

        Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. 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.

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. Default: false.

      • type — (String)

        Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

        Possible values include:
        • "BASIC"
        • "STANDARD"
        • "ADVANCED_SD"
        • "ADVANCED_HD"
      • preset — (String)

        Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

        Possible values include:
        • "HIGHER_BANDWIDTH_DELIVERY"
        • "CONSTRAINED_BANDWIDTH_DELIVERY"
      • playbackRestrictionPolicyArn — (String)

        Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

    • 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: {}) —
  • nextToken — (String)

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

  • maxResults — (Integer)

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

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.listPlaybackRestrictionPolicies(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: {}) —
  • nextToken — (String)

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

  • maxResults — (Integer)

    Maximum number of policies to return. Default: 1.

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:

    • playbackRestrictionPolicies — (Array<map>)

      List of the matching policies.

      • arn — required — (String)

        Playback-restriction-policy ARN

      • allowedCountries — required — (Array<String>)

        A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

      • allowedOrigins — required — (Array<String>)

        A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

      • enableStrictOriginEnforcement — (Boolean)

        Whether channel playback is constrained by origin site. Default: false.

      • name — (String)

        Playback-restriction-policy 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 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.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: {}) —
  • nextToken — (String)

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

  • maxResults — (Integer)

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

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:

    • recordingConfigurations — (Array<map>)

      List of the matching recording configurations.

      • arn — required — (String)

        Recording-configuration ARN.

      • name — (String)

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

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

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

    • nextToken — (String)

      If there are more recording configurations 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 = {
  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.

  • nextToken — (String)

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

  • maxResults — (Integer)

    Maximum number of streamKeys to return. Default: 1.

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:

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

    • nextToken — (String)

      If there are more stream keys 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 = {
  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"
  • nextToken — (String)

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

  • maxResults — (Integer)

    Maximum number of streams to return. Default: 100.

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:

    • streams — (Array<map>)

      List of streams.

      • channelArn — (String)

        Channel ARN for the stream.

      • streamId — (String)

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

      • 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"
      • health — (String)

        The stream’s health.

        Possible values include:
        • "HEALTHY"
        • "STARVING"
        • "UNKNOWN"
      • 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.

      • startTime — (Date)

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

    • nextToken — (String)

      If there are more streams 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 = {
  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.

  • nextToken — (String)

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

  • maxResults — (Integer)

    Maximum number of streams to return. Default: 100.

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:

    • streamSessions — (Array<map>)

      List of stream sessions.

      • streamId — (String)

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

      • startTime — (Date)

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

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

    • nextToken — (String)

      If there are more streams 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 = {
  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 */
  viewerId: 'STRING_VALUE', /* required */
  viewerSessionVersionsLessThanOrEqualTo: 'NUMBER_VALUE'
};
ivs.startViewerSessionRevocation(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)

    The ARN of the channel associated with the viewer session to revoke.

  • viewerId — (String)

    The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

  • viewerSessionVersionsLessThanOrEqualTo — (Integer)

    An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

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',
  playbackRestrictionPolicyArn: 'STRING_VALUE',
  preset: HIGHER_BANDWIDTH_DELIVERY | CONSTRAINED_BANDWIDTH_DELIVERY,
  recordingConfigurationArn: 'STRING_VALUE',
  type: BASIC | STANDARD | ADVANCED_SD | ADVANCED_HD
};
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.

  • name — (String)

    Channel name.

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

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

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

    Possible values include:
    • "BASIC"
    • "STANDARD"
    • "ADVANCED_SD"
    • "ADVANCED_HD"
  • authorized — (Boolean)

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

  • recordingConfigurationArn — (String)

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

  • insecureIngest — (Boolean)

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

  • preset — (String)

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

    Possible values include:
    • "HIGHER_BANDWIDTH_DELIVERY"
    • "CONSTRAINED_BANDWIDTH_DELIVERY"
  • playbackRestrictionPolicyArn — (String)

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

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 the updated channel.

      • arn — (String)

        Channel ARN.

      • name — (String)

        Channel name.

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

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

        Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

        Possible values include:
        • "BASIC"
        • "STANDARD"
        • "ADVANCED_SD"
        • "ADVANCED_HD"
      • recordingConfigurationArn — (String)

        Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

      • ingestEndpoint — (String)

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

      • playbackUrl — (String)

        Channel playback URL.

      • authorized — (Boolean)

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

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

      • insecureIngest — (Boolean)

        Whether the channel allows insecure RTMP ingest. Default: false.

      • preset — (String)

        Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

        Possible values include:
        • "HIGHER_BANDWIDTH_DELIVERY"
        • "CONSTRAINED_BANDWIDTH_DELIVERY"
      • srt — (map)

        Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

        • endpoint — (String)

          The endpoint to be used when streaming with IVS using the SRT protocol.

        • passphrase — (String)

          Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.

      • playbackRestrictionPolicyArn — (String)

        Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE', /* required */
  allowedCountries: [
    'STRING_VALUE',
    /* more items */
  ],
  allowedOrigins: [
    'STRING_VALUE',
    /* more items */
  ],
  enableStrictOriginEnforcement: true || false,
  name: 'STRING_VALUE'
};
ivs.updatePlaybackRestrictionPolicy(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 playback-restriction-policy to be updated.

  • allowedCountries — (Array<String>)

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

  • allowedOrigins — (Array<String>)

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

  • enableStrictOriginEnforcement — (Boolean)

    Whether channel playback is constrained by origin site. Default: false.

  • name — (String)

    Playback-restriction-policy name. The value does not need to be unique.

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:

    • playbackRestrictionPolicy — (map)

      Object specifying the updated policy.

      • arn — required — (String)

        Playback-restriction-policy ARN

      • allowedCountries — required — (Array<String>)

        A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

      • allowedOrigins — required — (Array<String>)

        A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

      • enableStrictOriginEnforcement — (Boolean)

        Whether channel playback is constrained by origin site. Default: false.

      • name — (String)

        Playback-restriction-policy 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.