Skip to content

Latest commit

 

History

History

amazonaws_kinesisvideo

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_kinesisvideo

Client library for Amazon Kinesis Video Streams

Installation and Usage

npm install --save @datafire/amazonaws_kinesisvideo
let amazonaws_kinesisvideo = require('@datafire/amazonaws_kinesisvideo').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

ListTagsForResource

amazonaws_kinesisvideo.ListTagsForResource({
  "ResourceARN": ""
}, context)

Input

  • input object
    • 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 required string: The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags.

Output

TagResource

amazonaws_kinesisvideo.TagResource({
  "ResourceARN": "",
  "Tags": []
}, context)

Input

  • input object
    • ResourceARN required string: The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.
    • Tags required array: A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.

Output

UntagResource

amazonaws_kinesisvideo.UntagResource({
  "ResourceARN": "",
  "TagKeyList": []
}, context)

Input

  • input object
    • ResourceARN required string: The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags.
    • TagKeyList required array: A list of the keys of the tags that you want to remove.

Output

CreateSignalingChannel

amazonaws_kinesisvideo.CreateSignalingChannel({
  "ChannelName": ""
}, context)

Input

  • input object
    • ChannelName required string: A name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region.
    • ChannelType string (values: SINGLE_MASTER): A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.
    • SingleMasterConfiguration object: A structure that contains the configuration for the SINGLE_MASTER channel type.
      • MessageTtlSeconds
    • Tags array: A set of tags (key-value pairs) that you want to associate with this channel.

Output

CreateStream

amazonaws_kinesisvideo.CreateStream({
  "StreamName": ""
}, context)

Input

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

    • DeviceName string:

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

      In the current implementation, Kinesis Video Streams does not use this name.

    • KmsKeyId string:

      The ID of the AWS Key Management Service (AWS 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 (aws/kinesisvideo) is used.

      For more information, see DescribeKey.

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

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

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

Output

DeleteSignalingChannel

amazonaws_kinesisvideo.DeleteSignalingChannel({
  "ChannelARN": ""
}, context)

Input

  • input object
    • ChannelARN required 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.

Output

DeleteStream

amazonaws_kinesisvideo.DeleteStream({
  "StreamARN": ""
}, context)

Input

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

    • StreamARN required string: The Amazon Resource Name (ARN) of the stream that you want to delete.

Output

DescribeSignalingChannel

amazonaws_kinesisvideo.DescribeSignalingChannel({}, context)

Input

  • input object
    • ChannelARN string: The ARN of the signaling channel that you want to describe.
    • ChannelName string: The name of the signaling channel that you want to describe.

Output

DescribeStream

amazonaws_kinesisvideo.DescribeStream({}, context)

Input

  • input object
    • StreamARN string: The Amazon Resource Name (ARN) of the stream.
    • StreamName string: The name of the stream.

Output

GetDataEndpoint

amazonaws_kinesisvideo.GetDataEndpoint({
  "APIName": ""
}, context)

Input

  • input object
    • APIName required string (values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL, GET_CLIP): The name of the API action for which to get an endpoint.
    • 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.
    • 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.

Output

GetSignalingChannelEndpoint

amazonaws_kinesisvideo.GetSignalingChannelEndpoint({
  "ChannelARN": ""
}, context)

Input

  • input object
    • ChannelARN required string: The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.
    • SingleMasterChannelEndpointConfiguration object: An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

Output

ListSignalingChannels

amazonaws_kinesisvideo.ListSignalingChannels({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ChannelNameCondition object: An optional input parameter for the ListSignalingChannels API. When this parameter is specified while invoking ListSignalingChannels, the API returns only the channels that satisfy a condition specified in ChannelNameCondition.
      • ComparisonOperator
      • ComparisonValue
    • 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.

Output

ListStreams

amazonaws_kinesisvideo.ListStreams({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • 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 object: Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.
      • ComparisonOperator
      • ComparisonValue

Output

ListTagsForStream

amazonaws_kinesisvideo.ListTagsForStream({}, context)

Input

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

Output

TagStream

amazonaws_kinesisvideo.TagStream({
  "Tags": {}
}, context)

Input

  • input object
    • 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 required object: A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Output

UntagStream

amazonaws_kinesisvideo.UntagStream({
  "TagKeyList": []
}, context)

Input

  • input object
    • 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 required array: A list of the keys of the tags that you want to remove.

Output

UpdateDataRetention

amazonaws_kinesisvideo.UpdateDataRetention({
  "CurrentVersion": "",
  "Operation": "",
  "DataRetentionChangeInHours": 0
}, context)

Input

  • input object
    • CurrentVersion required 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.
    • DataRetentionChangeInHours required integer: The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
    • Operation required string (values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION): Indicates whether you want to increase or decrease the retention period.
    • StreamARN string: The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
    • StreamName string: The name of the stream whose retention period you want to change.

Output

UpdateSignalingChannel

amazonaws_kinesisvideo.UpdateSignalingChannel({
  "ChannelARN": "",
  "CurrentVersion": ""
}, context)

Input

  • input object
    • ChannelARN required string: The Amazon Resource Name (ARN) of the signaling channel that you want to update.
    • CurrentVersion required string: The current version of the signaling channel that you want to update.
    • SingleMasterConfiguration object: A structure that contains the configuration for the SINGLE_MASTER channel type.
      • MessageTtlSeconds

Output

UpdateStream

amazonaws_kinesisvideo.UpdateStream({
  "CurrentVersion": ""
}, context)

Input

  • input object
    • CurrentVersion required 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.

      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.

    • StreamARN string: The ARN of the stream whose metadata you want to update.
    • 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.

Output

Definitions

APIName

  • APIName string (values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL, GET_CLIP)

AccessDeniedException

AccountChannelLimitExceededException

AccountStreamLimitExceededException

ChannelInfo

  • ChannelInfo object: A structure that encapsulates a signaling channel's metadata and properties.
    • ChannelARN
    • ChannelName
    • ChannelStatus
    • ChannelType
    • CreationTime
    • SingleMasterConfiguration
      • MessageTtlSeconds
    • Version

ChannelInfoList

ChannelName

  • ChannelName string

ChannelNameCondition

  • ChannelNameCondition object: An optional input parameter for the ListSignalingChannels API. When this parameter is specified while invoking ListSignalingChannels, the API returns only the channels that satisfy a condition specified in ChannelNameCondition.
    • ComparisonOperator
    • ComparisonValue

ChannelProtocol

  • ChannelProtocol string (values: WSS, HTTPS)

ChannelRole

  • ChannelRole string (values: MASTER, VIEWER)

ChannelType

  • ChannelType string (values: SINGLE_MASTER)

ClientLimitExceededException

ComparisonOperator

  • ComparisonOperator string (values: BEGINS_WITH)

CreateSignalingChannelInput

  • CreateSignalingChannelInput object
    • ChannelName required
    • ChannelType
    • SingleMasterConfiguration
      • MessageTtlSeconds
    • Tags

CreateSignalingChannelOutput

  • CreateSignalingChannelOutput object
    • ChannelARN

CreateStreamInput

  • CreateStreamInput object
    • DataRetentionInHours
    • DeviceName
    • KmsKeyId
    • MediaType
    • StreamName required
    • Tags

CreateStreamOutput

  • CreateStreamOutput object
    • StreamARN

DataEndpoint

  • DataEndpoint string

DataRetentionChangeInHours

  • DataRetentionChangeInHours integer

DataRetentionInHours

  • DataRetentionInHours integer

DeleteSignalingChannelInput

  • DeleteSignalingChannelInput object
    • ChannelARN required
    • CurrentVersion

DeleteSignalingChannelOutput

  • DeleteSignalingChannelOutput object

DeleteStreamInput

  • DeleteStreamInput object
    • CurrentVersion
    • StreamARN required

DeleteStreamOutput

  • DeleteStreamOutput object

DescribeSignalingChannelInput

  • DescribeSignalingChannelInput object
    • ChannelARN
    • ChannelName

DescribeSignalingChannelOutput

  • DescribeSignalingChannelOutput object
    • ChannelInfo
      • ChannelARN
      • ChannelName
      • ChannelStatus
      • ChannelType
      • CreationTime
      • SingleMasterConfiguration
        • MessageTtlSeconds
      • Version

DescribeStreamInput

  • DescribeStreamInput object
    • StreamARN
    • StreamName

DescribeStreamOutput

  • DescribeStreamOutput object
    • StreamInfo
      • CreationTime
      • DataRetentionInHours
      • DeviceName
      • KmsKeyId
      • MediaType
      • Status
      • StreamARN
      • StreamName
      • Version

DeviceName

  • DeviceName string

DeviceStreamLimitExceededException

GetDataEndpointInput

  • GetDataEndpointInput object
    • APIName required
    • StreamARN
    • StreamName

GetDataEndpointOutput

  • GetDataEndpointOutput object
    • DataEndpoint

GetSignalingChannelEndpointInput

  • GetSignalingChannelEndpointInput object
    • ChannelARN required
    • SingleMasterChannelEndpointConfiguration

GetSignalingChannelEndpointOutput

InvalidArgumentException

InvalidDeviceException

InvalidResourceFormatException

KmsKeyId

  • KmsKeyId string

ListOfProtocols

ListSignalingChannelsInput

  • ListSignalingChannelsInput object
    • ChannelNameCondition
      • ComparisonOperator
      • ComparisonValue
    • MaxResults
    • NextToken

ListSignalingChannelsOutput

  • ListSignalingChannelsOutput object

ListStreamsInput

  • ListStreamsInput object
    • MaxResults
    • NextToken
    • StreamNameCondition
      • ComparisonOperator
      • ComparisonValue

ListStreamsInputLimit

  • ListStreamsInputLimit integer

ListStreamsOutput

  • ListStreamsOutput object

ListTagsForResourceInput

  • ListTagsForResourceInput object
    • NextToken
    • ResourceARN required

ListTagsForResourceOutput

  • ListTagsForResourceOutput object
    • NextToken
    • Tags

ListTagsForStreamInput

  • ListTagsForStreamInput object
    • NextToken
    • StreamARN
    • StreamName

ListTagsForStreamOutput

  • ListTagsForStreamOutput object
    • NextToken
    • Tags

MediaType

  • MediaType string

MessageTtlSeconds

  • MessageTtlSeconds integer

NextToken

  • NextToken string

NotAuthorizedException

ResourceARN

  • ResourceARN string

ResourceEndpoint

  • ResourceEndpoint string

ResourceEndpointList

ResourceEndpointListItem

  • ResourceEndpointListItem object: An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.
    • Protocol
    • ResourceEndpoint

ResourceInUseException

ResourceNotFoundException

ResourceTags

  • ResourceTags object

SingleMasterChannelEndpointConfiguration

  • SingleMasterChannelEndpointConfiguration object: An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

SingleMasterConfiguration

  • SingleMasterConfiguration object: A structure that contains the configuration for the SINGLE_MASTER channel type.
    • MessageTtlSeconds

Status

  • Status string (values: CREATING, ACTIVE, UPDATING, DELETING)

StreamInfo

  • StreamInfo object: An object describing a Kinesis video stream.
    • CreationTime
    • DataRetentionInHours
    • DeviceName
    • KmsKeyId
    • MediaType
    • Status
    • StreamARN
    • StreamName
    • Version

StreamInfoList

StreamName

  • StreamName string

StreamNameCondition

  • StreamNameCondition object: Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.
    • ComparisonOperator
    • ComparisonValue

Tag

  • Tag object: A key and value pair that is associated with the specified signaling channel.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagOnCreateList

  • TagOnCreateList array

TagResourceInput

  • TagResourceInput object
    • ResourceARN required
    • Tags required

TagResourceOutput

  • TagResourceOutput object

TagStreamInput

  • TagStreamInput object
    • StreamARN
    • StreamName
    • Tags required

TagStreamOutput

  • TagStreamOutput object

TagValue

  • TagValue string

TagsPerResourceExceededLimitException

Timestamp

  • Timestamp string

UntagResourceInput

  • UntagResourceInput object
    • ResourceARN required
    • TagKeyList required

UntagResourceOutput

  • UntagResourceOutput object

UntagStreamInput

  • UntagStreamInput object
    • StreamARN
    • StreamName
    • TagKeyList required

UntagStreamOutput

  • UntagStreamOutput object

UpdateDataRetentionInput

  • UpdateDataRetentionInput object
    • CurrentVersion required
    • DataRetentionChangeInHours required
    • Operation required
    • StreamARN
    • StreamName

UpdateDataRetentionOperation

  • UpdateDataRetentionOperation string (values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION)

UpdateDataRetentionOutput

  • UpdateDataRetentionOutput object

UpdateSignalingChannelInput

  • UpdateSignalingChannelInput object
    • ChannelARN required
    • CurrentVersion required
    • SingleMasterConfiguration
      • MessageTtlSeconds

UpdateSignalingChannelOutput

  • UpdateSignalingChannelOutput object

UpdateStreamInput

  • UpdateStreamInput object
    • CurrentVersion required
    • DeviceName
    • MediaType
    • StreamARN
    • StreamName

UpdateStreamOutput

  • UpdateStreamOutput object

Version

  • Version string

VersionMismatchException