Class: AWS.KinesisVideo

var params = {
  StreamName: 'STRING_VALUE', /* required */
  DataRetentionInHours: 'NUMBER_VALUE',
  DeviceName: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MediaType: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
kinesisvideo.createStream(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: {}) —
  • DeviceName — (String)

    The name of the device that is writing to the stream.

    Note: In the current implementation, Kinesis Video Streams does not use this name.
  • StreamName — (String)

    A name for the stream that you are creating.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • MediaType — (String)

    The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

    Example valid values include "video/h264" and "video/h264,audio/aac".

    This parameter is optional; the default value is null (or empty in JSON).

  • KmsKeyId — (String)

    The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

    If no key ID is specified, the default, Kinesis Video-managed key (Amazon Web Services/kinesisvideo) is used.

    For more information, see DescribeKey.

  • DataRetentionInHours — (Integer)

    The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

    The default value is 0, indicating that the stream does not persist data.

    When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

  • Tags — (map<String>)

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

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:

    • StreamARN — (String)

      The Amazon Resource Name (ARN) of the stream.

Returns:

• (AWS.Request) —

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

var params = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.deleteEdgeConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream from which to delete the edge configuration. Specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.

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 */
  CurrentVersion: 'STRING_VALUE'
};
kinesisvideo.deleteSignalingChannel(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 Amazon Resource Name (ARN) of the signaling channel that you want to delete.

  • CurrentVersion — (String)

    The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels API operations.

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 = {
  StreamARN: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE'
};
kinesisvideo.deleteStream(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: {}) —
  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream that you want to delete.

  • CurrentVersion — (String)

    Optional: The version of the stream that you want to delete.

    Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

    If not specified, only the CreationTime is checked before deleting the stream.

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 = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.describeEdgeConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

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:

    • StreamName — (String)

      The name of the stream from which the edge configuration was updated.

    • StreamARN — (String)

      The Amazon Resource Name (ARN) of the stream.

    • CreationTime — (Date)

      The timestamp at which a stream’s edge configuration was first created.

    • LastUpdatedTime — (Date)

      The timestamp at which a stream’s edge configuration was last updated.

    • SyncStatus — (String)

      The latest status of the edge configuration update.

      Possible values include:
      • "SYNCING"
      • "ACKNOWLEDGED"
      • "IN_SYNC"
      • "SYNC_FAILED"
      • "DELETING"
      • "DELETE_FAILED"
      • "DELETING_ACKNOWLEDGED"
    • FailedStatusDetails — (String)

      A description of the generated failure status.

    • EdgeConfig — (map)

      A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

      • HubDeviceArn — required — (String)

        The "Internet of Things (IoT) Thing" Arn of the stream.

      • RecorderConfig — required — (map)

        The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

        • MediaSourceConfig — required — (map)

          The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

          • MediaUriSecretArn — required — (String)

            The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

          • MediaUriType — required — (String)

            The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

            Note: Preview only supports the RTSP_URI media source URI format .
            Possible values include:
            • "RTSP_URI"
            • "FILE_URI"
        • ScheduleConfig — (map)

          The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

          • ScheduleExpression — required — (String)

            The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

            For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

          • DurationInSeconds — required — (Integer)

            The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

      • UploaderConfig — (map)

        The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

        • ScheduleConfig — required — (map)

          The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

          • ScheduleExpression — required — (String)

            The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

            For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

          • DurationInSeconds — required — (Integer)

            The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

      • DeletionConfig — (map)

        The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

        • EdgeRetentionInHours — (Integer)

          The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

        • LocalSizeConfig — (map)

          The value of the local size required in order to delete the edge configuration.

          • MaxLocalMediaSizeInMB — (Integer)

            The overall maximum size of the media that you want to store for a stream on the Edge Agent.

          • StrategyOnFullSize — (String)

            The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

            Possible values include:
            • "DELETE_OLDEST_MEDIA"
            • "DENY_NEW_MEDIA"
        • DeleteAfterUpload — (Boolean)

          The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

          Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

    • EdgeAgentStatus — (map)

      An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

      • LastRecorderStatus — (map)

        The latest status of a stream’s edge recording job.

        • JobStatusDetails — (String)

          A description of a recorder job’s latest status.

        • LastCollectedTime — (Date)

          The timestamp at which the recorder job was last executed and media stored to local disk.

        • LastUpdatedTime — (Date)

          The timestamp at which the recorder status was last updated.

        • RecorderStatus — (String)

          The status of the latest recorder job.

          Possible values include:
          • "SUCCESS"
          • "USER_ERROR"
          • "SYSTEM_ERROR"
      • LastUploaderStatus — (map)

        The latest status of a stream’s edge to cloud uploader job.

        • JobStatusDetails — (String)

          A description of an uploader job’s latest status.

        • LastCollectedTime — (Date)

          The timestamp at which the uploader job was last executed and media collected to the cloud.

        • LastUpdatedTime — (Date)

          The timestamp at which the uploader status was last updated.

        • UploaderStatus — (String)

          The status of the latest uploader job.

          Possible values include:
          • "SUCCESS"
          • "USER_ERROR"
          • "SYSTEM_ERROR"

Returns:

• (AWS.Request) —

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

var params = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.describeImageGenerationConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

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:

    • ImageGenerationConfiguration — (map)

      The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

      • Status — required — (String)

        Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • ImageSelectorType — required — (String)

        The origin of the Server or Producer timestamps to use to generate the images.

        Possible values include:
        • "SERVER_TIMESTAMP"
        • "PRODUCER_TIMESTAMP"
      • DestinationConfig — required — (map)

        The structure that contains the information required to deliver images to a customer.

        • Uri — required — (String)

          The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

        • DestinationRegion — required — (String)

          The Amazon Web Services Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

      • SamplingInterval — required — (Integer)

        The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

      • Format — required — (String)

        The accepted image format.

        Possible values include:
        • "JPEG"
        • "PNG"
      • FormatConfig — (map<String>)

        The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

      • WidthPixels — (Integer)

        The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

      • HeightPixels — (Integer)

        The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.describeMappedResourceConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream.

  • MaxResults — (Integer)

    The maximum number of results to return in the response.

  • NextToken — (String)

    The token to provide in your next request, to get another batch of results.

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:

    • MappedResourceConfigurationList — (Array<map>)

      A structure that encapsulates, or contains, the media storage configuration properties.

      • Type — (String)

        The type of the associated resource for the kinesis video stream.

      • ARN — (String)

        The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.

    • NextToken — (String)

      The token that was used in the NextTokenrequest to fetch the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelARN: 'STRING_VALUE',
  ChannelName: 'STRING_VALUE'
};
kinesisvideo.describeMediaStorageConfiguration(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: {}) —
  • ChannelName — (String)

    The name of the channel.

  • ChannelARN — (String)

    The Amazon Resource Name (ARN) of the channel.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • MediaStorageConfiguration — (map)

      A structure that encapsulates, or contains, the media storage configuration properties.

      • StreamARN — (String)

        The Amazon Resource Name (ARN) of the stream.

      • Status — required — (String)

        The status of the media storage configuration.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

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

var params = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.describeNotificationConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream from which to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

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:

    • NotificationConfiguration — (map)

      The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

      • Status — required — (String)

        Indicates if a notification configuration is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • DestinationConfig — required — (map)

        The destination information required to deliver a notification to a customer.

        • Uri — required — (String)

          The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelARN: 'STRING_VALUE',
  ChannelName: 'STRING_VALUE'
};
kinesisvideo.describeSignalingChannel(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: {}) —
  • ChannelName — (String)

    The name of the signaling channel that you want to describe.

  • ChannelARN — (String)

    The ARN of the signaling channel that you want to describe.

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:

    • ChannelInfo — (map)

      A structure that encapsulates the specified signaling channel's metadata and properties.

      • ChannelName — (String)

        The name of the signaling channel.

      • ChannelARN — (String)

        The Amazon Resource Name (ARN) of the signaling channel.

      • ChannelType — (String)

        The type of the signaling channel.

        Possible values include:
        • "SINGLE_MASTER"
        • "FULL_MESH"
      • ChannelStatus — (String)

        Current status of the signaling channel.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
      • CreationTime — (Date)

        The time at which the signaling channel was created.

      • SingleMasterConfiguration — (map)

        A structure that contains the configuration for the SINGLE_MASTER channel type.

        • MessageTtlSeconds — (Integer)

          The period of time a signaling channel retains undelivered messages before they are discarded.

      • Version — (String)

        The current version of the signaling channel.

Returns:

• (AWS.Request) —

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

var params = {
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.describeStream(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: {}) —
  • StreamName — (String)

    The name of the stream.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream.

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:

    • StreamInfo — (map)

      An object that describes the stream.

      • DeviceName — (String)

        The name of the device that is associated with the stream.

      • StreamName — (String)

        The name of the stream.

      • StreamARN — (String)

        The Amazon Resource Name (ARN) of the stream.

      • MediaType — (String)

        The MediaType of the stream.

      • KmsKeyId — (String)

        The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

      • Version — (String)

        The version of the stream.

      • Status — (String)

        The status of the stream.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
      • CreationTime — (Date)

        A time stamp that indicates when the stream was created.

      • DataRetentionInHours — (Integer)

        How long the stream retains data, in hours.

Returns:

• (AWS.Request) —

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

var params = {
  APIName: PUT_MEDIA | GET_MEDIA | LIST_FRAGMENTS | GET_MEDIA_FOR_FRAGMENT_LIST | GET_HLS_STREAMING_SESSION_URL | GET_DASH_STREAMING_SESSION_URL | GET_CLIP | GET_IMAGES, /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.getDataEndpoint(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: {}) —
  • StreamName — (String)

    The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

  • APIName — (String)

    The name of the API action for which to get an endpoint.

    Possible values include:
    • "PUT_MEDIA"
    • "GET_MEDIA"
    • "LIST_FRAGMENTS"
    • "GET_MEDIA_FOR_FRAGMENT_LIST"
    • "GET_HLS_STREAMING_SESSION_URL"
    • "GET_DASH_STREAMING_SESSION_URL"
    • "GET_CLIP"
    • "GET_IMAGES"

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:

    • DataEndpoint — (String)

      The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelARN: 'STRING_VALUE', /* required */
  SingleMasterChannelEndpointConfiguration: {
    Protocols: [
      WSS | HTTPS | WEBRTC,
      /* more items */
    ],
    Role: MASTER | VIEWER
  }
};
kinesisvideo.getSignalingChannelEndpoint(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 Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

  • SingleMasterChannelEndpointConfiguration — (map)

    A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

    • Protocols — (Array<String>)

      This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

    • Role — (String)

      This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

      Possible values include:
      • "MASTER"
      • "VIEWER"

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:

    • ResourceEndpointList — (Array<map>)

      A list of endpoints for the specified signaling channel.

      • Protocol — (String)

        The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.

        Possible values include:
        • "WSS"
        • "HTTPS"
        • "WEBRTC"
      • ResourceEndpoint — (String)

        The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

Returns:

• (AWS.Request) —

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

var params = {
  HubDeviceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesisvideo.listEdgeAgentConfigurations(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: {}) —
  • HubDeviceArn — (String)

    The "Internet of Things (IoT) Thing" Arn of the edge agent.

  • MaxResults — (Integer)

    The maximum number of edge configurations to return in the response. The default is 5.

  • NextToken — (String)

    If you specify this parameter, when the result of a ListEdgeAgentConfigurations operation is truncated, the call returns the NextToken in the response. To get another batch of edge configurations, provide this token in your next 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. The data object has the following properties:

    • EdgeConfigs — (Array<map>)

      A description of a single stream's edge configuration.

      • StreamName — (String)

        The name of the stream.

      • StreamARN — (String)

        The Amazon Resource Name (ARN) of the stream.

      • CreationTime — (Date)

        The timestamp when the stream first created the edge config.

      • LastUpdatedTime — (Date)

        The timestamp when the stream last updated the edge config.

      • SyncStatus — (String)

        The current sync status of the stream's edge configuration.

        Possible values include:
        • "SYNCING"
        • "ACKNOWLEDGED"
        • "IN_SYNC"
        • "SYNC_FAILED"
        • "DELETING"
        • "DELETE_FAILED"
        • "DELETING_ACKNOWLEDGED"
      • FailedStatusDetails — (String)

        A description of the generated failure status.

      • EdgeConfig — (map)

        A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

        • HubDeviceArn — required — (String)

          The "Internet of Things (IoT) Thing" Arn of the stream.

        • RecorderConfig — required — (map)

          The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

          • MediaSourceConfig — required — (map)

            The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

            • MediaUriSecretArn — required — (String)

              The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

            • MediaUriType — required — (String)

              The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

              Note: Preview only supports the RTSP_URI media source URI format .
              Possible values include:
              • "RTSP_URI"
              • "FILE_URI"
          • ScheduleConfig — (map)

            The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

            • ScheduleExpression — required — (String)

              The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

              For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

            • DurationInSeconds — required — (Integer)

              The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

        • UploaderConfig — (map)

          The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

          • ScheduleConfig — required — (map)

            The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

            • ScheduleExpression — required — (String)

              The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

              For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

            • DurationInSeconds — required — (Integer)

              The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

        • DeletionConfig — (map)

          The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

          • EdgeRetentionInHours — (Integer)

            The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

          • LocalSizeConfig — (map)

            The value of the local size required in order to delete the edge configuration.

            • MaxLocalMediaSizeInMB — (Integer)

              The overall maximum size of the media that you want to store for a stream on the Edge Agent.

            • StrategyOnFullSize — (String)

              The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

              Possible values include:
              • "DELETE_OLDEST_MEDIA"
              • "DENY_NEW_MEDIA"
          • DeleteAfterUpload — (Boolean)

            The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

            Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

    • NextToken — (String)

      If the response is truncated, the call returns this element with a given token. To get the next batch of edge configurations, use this token in your next request.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelNameCondition: {
    ComparisonOperator: BEGINS_WITH,
    ComparisonValue: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesisvideo.listSignalingChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The maximum number of channels to return in the response. The default is 500.

  • NextToken — (String)

    If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

  • ChannelNameCondition — (map)

    Optional: Returns only the channels that satisfy a specific condition.

    • ComparisonOperator — (String)

      A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.

      Possible values include:
      • "BEGINS_WITH"
    • ComparisonValue — (String)

      A value to compare.

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:

    • ChannelInfoList — (Array<map>)

      An array of ChannelInfo objects.

      • ChannelName — (String)

        The name of the signaling channel.

      • ChannelARN — (String)

        The Amazon Resource Name (ARN) of the signaling channel.

      • ChannelType — (String)

        The type of the signaling channel.

        Possible values include:
        • "SINGLE_MASTER"
        • "FULL_MESH"
      • ChannelStatus — (String)

        Current status of the signaling channel.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
      • CreationTime — (Date)

        The time at which the signaling channel was created.

      • SingleMasterConfiguration — (map)

        A structure that contains the configuration for the SINGLE_MASTER channel type.

        • MessageTtlSeconds — (Integer)

          The period of time a signaling channel retains undelivered messages before they are discarded.

      • Version — (String)

        The current version of the signaling channel.

    • NextToken — (String)

      If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StreamNameCondition: {
    ComparisonOperator: BEGINS_WITH,
    ComparisonValue: 'STRING_VALUE'
  }
};
kinesisvideo.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: {}) —
  • MaxResults — (Integer)

    The maximum number of streams to return in the response. The default is 10,000.

  • NextToken — (String)

    If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

  • StreamNameCondition — (map)

    Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

    • ComparisonOperator — (String)

      A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

      Possible values include:
      • "BEGINS_WITH"
    • ComparisonValue — (String)

      A value to compare.

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:

    • StreamInfoList — (Array<map>)

      An array of StreamInfo objects.

      • DeviceName — (String)

        The name of the device that is associated with the stream.

      • StreamName — (String)

        The name of the stream.

      • StreamARN — (String)

        The Amazon Resource Name (ARN) of the stream.

      • MediaType — (String)

        The MediaType of the stream.

      • KmsKeyId — (String)

        The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

      • Version — (String)

        The version of the stream.

      • Status — (String)

        The status of the stream.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
      • CreationTime — (Date)

        A time stamp that indicates when the stream was created.

      • DataRetentionInHours — (Integer)

        How long the stream retains data, in hours.

    • NextToken — (String)

      If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
kinesisvideo.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: {}) —
  • NextToken — (String)

    If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextToken — (String)

      If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

    • Tags — (map<String>)

      A map of tag keys and values associated with the specified signaling channel.

Returns:

• (AWS.Request) —

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

var params = {
  NextToken: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.listTagsForStream(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)

    If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream that you want to list tags for.

  • StreamName — (String)

    The name of the stream that you want to list tags for.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextToken — (String)

      If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

    • Tags — (map<String>)

      A map of tag keys and values associated with the specified stream.

Returns:

• (AWS.Request) —

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

var params = {
  EdgeConfig: { /* required */
    HubDeviceArn: 'STRING_VALUE', /* required */
    RecorderConfig: { /* required */
      MediaSourceConfig: { /* required */
        MediaUriSecretArn: 'STRING_VALUE', /* required */
        MediaUriType: RTSP_URI | FILE_URI /* required */
      },
      ScheduleConfig: {
        DurationInSeconds: 'NUMBER_VALUE', /* required */
        ScheduleExpression: 'STRING_VALUE' /* required */
      }
    },
    DeletionConfig: {
      DeleteAfterUpload: true || false,
      EdgeRetentionInHours: 'NUMBER_VALUE',
      LocalSizeConfig: {
        MaxLocalMediaSizeInMB: 'NUMBER_VALUE',
        StrategyOnFullSize: DELETE_OLDEST_MEDIA | DENY_NEW_MEDIA
      }
    },
    UploaderConfig: {
      ScheduleConfig: { /* required */
        DurationInSeconds: 'NUMBER_VALUE', /* required */
        ScheduleExpression: 'STRING_VALUE' /* required */
      }
    }
  },
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.startEdgeConfigurationUpdate(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: {}) —
  • StreamName — (String)

    The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.

  • EdgeConfig — (map)

    The edge configuration details required to invoke the update process.

    • HubDeviceArn — required — (String)

      The "Internet of Things (IoT) Thing" Arn of the stream.

    • RecorderConfig — required — (map)

      The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

      • MediaSourceConfig — required — (map)

        The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

        • MediaUriSecretArn — required — (String)

          The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

        • MediaUriType — required — (String)

          The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

          Note: Preview only supports the RTSP_URI media source URI format .
          Possible values include:
          • "RTSP_URI"
          • "FILE_URI"
      • ScheduleConfig — (map)

        The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

        • ScheduleExpression — required — (String)

          The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

          For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

        • DurationInSeconds — required — (Integer)

          The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

    • UploaderConfig — (map)

      The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

      • ScheduleConfig — required — (map)

        The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

        • ScheduleExpression — required — (String)

          The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

          For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

        • DurationInSeconds — required — (Integer)

          The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

    • DeletionConfig — (map)

      The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

      • EdgeRetentionInHours — (Integer)

        The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

      • LocalSizeConfig — (map)

        The value of the local size required in order to delete the edge configuration.

        • MaxLocalMediaSizeInMB — (Integer)

          The overall maximum size of the media that you want to store for a stream on the Edge Agent.

        • StrategyOnFullSize — (String)

          The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

          Possible values include:
          • "DELETE_OLDEST_MEDIA"
          • "DENY_NEW_MEDIA"
      • DeleteAfterUpload — (Boolean)

        The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

        Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

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:

    • StreamName — (String)

      The name of the stream from which the edge configuration was updated.

    • StreamARN — (String)

      The Amazon Resource Name (ARN) of the stream.

    • CreationTime — (Date)

      The timestamp at which a stream’s edge configuration was first created.

    • LastUpdatedTime — (Date)

      The timestamp at which a stream’s edge configuration was last updated.

    • SyncStatus — (String)

      The current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API to get the latest status of the edge configuration.

      Possible values include:
      • "SYNCING"
      • "ACKNOWLEDGED"
      • "IN_SYNC"
      • "SYNC_FAILED"
      • "DELETING"
      • "DELETE_FAILED"
      • "DELETING_ACKNOWLEDGED"
    • FailedStatusDetails — (String)

      A description of the generated failure status.

    • EdgeConfig — (map)

      A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

      • HubDeviceArn — required — (String)

        The "Internet of Things (IoT) Thing" Arn of the stream.

      • RecorderConfig — required — (map)

        The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

        • MediaSourceConfig — required — (map)

          The configuration details that consist of the credentials required (MediaUriSecretArn and MediaUriType) to access the media files streamed to the camera.

          • MediaUriSecretArn — required — (String)

            The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

          • MediaUriType — required — (String)

            The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream local media files.

            Note: Preview only supports the RTSP_URI media source URI format .
            Possible values include:
            • "RTSP_URI"
            • "FILE_URI"
        • ScheduleConfig — (map)

          The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided, then the Edge Agent will always be set to recording mode.

          • ScheduleExpression — required — (String)

            The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

            For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

          • DurationInSeconds — required — (Integer)

            The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

      • UploaderConfig — (map)

        The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

        • ScheduleConfig — required — (map)

          The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).

          • ScheduleExpression — required — (String)

            The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

            For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.

          • DurationInSeconds — required — (Integer)

            The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

      • DeletionConfig — (map)

        The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

        • EdgeRetentionInHours — (Integer)

          The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.

        • LocalSizeConfig — (map)

          The value of the local size required in order to delete the edge configuration.

          • MaxLocalMediaSizeInMB — (Integer)

            The overall maximum size of the media that you want to store for a stream on the Edge Agent.

          • StrategyOnFullSize — (String)

            The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

            Possible values include:
            • "DELETE_OLDEST_MEDIA"
            • "DENY_NEW_MEDIA"
        • DeleteAfterUpload — (Boolean)

          The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached.

          Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kinesisvideo.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)

    The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.

  • Tags — (Array<map>)

    A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.

    • Key — required — (String)

      The key of the tag that is associated with the specified signaling channel.

    • Value — required — (String)

      The value of the tag that is associated with the specified signaling channel.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.tagStream(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: {}) —
  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

  • StreamName — (String)

    The name of the stream that you want to add the tag or tags to.

  • Tags — (map<String>)

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

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 */
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kinesisvideo.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)

    The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags.

  • TagKeyList — (Array<String>)

    A list of the keys of the tags that you want to remove.

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 = {
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.untagStream(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: {}) —
  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream that you want to remove tags from.

  • StreamName — (String)

    The name of the stream that you want to remove tags from.

  • TagKeyList — (Array<String>)

    A list of the keys of the tags that you want to remove.

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 = {
  CurrentVersion: 'STRING_VALUE', /* required */
  DataRetentionChangeInHours: 'NUMBER_VALUE', /* required */
  Operation: INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION, /* required */
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.updateDataRetention(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: {}) —
  • StreamName — (String)

    The name of the stream whose retention period you want to change.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

  • CurrentVersion — (String)

    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

  • Operation — (String)

    Indicates whether you want to increase or decrease the retention period.

    Possible values include:
    • "INCREASE_DATA_RETENTION"
    • "DECREASE_DATA_RETENTION"
  • DataRetentionChangeInHours — (Integer)

    The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation.

    The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

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 = {
  ImageGenerationConfiguration: {
    DestinationConfig: { /* required */
      DestinationRegion: 'STRING_VALUE', /* required */
      Uri: 'STRING_VALUE' /* required */
    },
    Format: JPEG | PNG, /* required */
    ImageSelectorType: SERVER_TIMESTAMP | PRODUCER_TIMESTAMP, /* required */
    SamplingInterval: 'NUMBER_VALUE', /* required */
    Status: ENABLED | DISABLED, /* required */
    FormatConfig: {
      '<FormatConfigKey>': 'STRING_VALUE',
      /* '<FormatConfigKey>': ... */
    },
    HeightPixels: 'NUMBER_VALUE',
    WidthPixels: 'NUMBER_VALUE'
  },
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.updateImageGenerationConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream from which to update the image generation configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the StreamName or the StreamARN.

  • ImageGenerationConfiguration — (map)

    The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream.

    • Status — required — (String)

      Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • ImageSelectorType — required — (String)

      The origin of the Server or Producer timestamps to use to generate the images.

      Possible values include:
      • "SERVER_TIMESTAMP"
      • "PRODUCER_TIMESTAMP"
    • DestinationConfig — required — (map)

      The structure that contains the information required to deliver images to a customer.

      • Uri — required — (String)

        The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

      • DestinationRegion — required — (String)

        The Amazon Web Services Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

    • SamplingInterval — required — (Integer)

      The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

    • Format — required — (String)

      The accepted image format.

      Possible values include:
      • "JPEG"
      • "PNG"
    • FormatConfig — (map<String>)

      The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

    • WidthPixels — (Integer)

      The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

    • HeightPixels — (Integer)

      The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will 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.

Returns:

• (AWS.Request) —

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

var params = {
  ChannelARN: 'STRING_VALUE', /* required */
  MediaStorageConfiguration: { /* required */
    Status: ENABLED | DISABLED, /* required */
    StreamARN: 'STRING_VALUE'
  }
};
kinesisvideo.updateMediaStorageConfiguration(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 Amazon Resource Name (ARN) of the channel.

  • MediaStorageConfiguration — (map)

    A structure that encapsulates, or contains, the media storage configuration properties.

    • StreamARN — (String)

      The Amazon Resource Name (ARN) of the stream.

    • Status — required — (String)

      The status of the media storage configuration.

      Possible values include:
      • "ENABLED"
      • "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.

Returns:

• (AWS.Request) —

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

var params = {
  NotificationConfiguration: {
    DestinationConfig: { /* required */
      Uri: 'STRING_VALUE' /* required */
    },
    Status: ENABLED | DISABLED /* required */
  },
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.updateNotificationConfiguration(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: {}) —
  • StreamName — (String)

    The name of the stream from which to update the notification configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN — (String)

    The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the StreamName or the StreamARN.

  • NotificationConfiguration — (map)

    The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

    • Status — required — (String)

      Indicates if a notification configuration is enabled or disabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • DestinationConfig — required — (map)

      The destination information required to deliver a notification to a customer.

      • Uri — required — (String)

        The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

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 */
  CurrentVersion: 'STRING_VALUE', /* required */
  SingleMasterConfiguration: {
    MessageTtlSeconds: 'NUMBER_VALUE'
  }
};
kinesisvideo.updateSignalingChannel(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 Amazon Resource Name (ARN) of the signaling channel that you want to update.

  • CurrentVersion — (String)

    The current version of the signaling channel that you want to update.

  • SingleMasterConfiguration — (map)

    The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

    • MessageTtlSeconds — (Integer)

      The period of time a signaling channel retains undelivered messages before they are discarded.

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 = {
  CurrentVersion: 'STRING_VALUE', /* required */
  DeviceName: 'STRING_VALUE',
  MediaType: 'STRING_VALUE',
  StreamARN: 'STRING_VALUE',
  StreamName: 'STRING_VALUE'
};
kinesisvideo.updateStream(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: {}) —
  • StreamName — (String)

    The name of the stream whose metadata you want to update.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • StreamARN — (String)

    The ARN of the stream whose metadata you want to update.

  • CurrentVersion — (String)

    The version of the stream whose metadata you want to update.

  • DeviceName — (String)

    The name of the device that is writing to the stream.

    Note: In the current implementation, Kinesis Video Streams does not use this name.
  • MediaType — (String)

    The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

    To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

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.