Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/kinesisvideo.ts?docs=full";

§Classes

KinesisVideo

§Interfaces

ChannelInfo

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

ChannelNameCondition

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.

CreateSignalingChannelInput
CreateSignalingChannelOutput
CreateStreamInput
CreateStreamOutput
DeleteSignalingChannelInput
DeleteStreamInput
DeletionConfig

The configuration details required to delete the connection of the stream from the Edge Agent.

DescribeEdgeConfigurationInput
DescribeEdgeConfigurationOutput
DescribeImageGenerationConfigurationInput
DescribeImageGenerationConfigurationOutput
DescribeMappedResourceConfigurationInput
DescribeMappedResourceConfigurationOutput
DescribeMediaStorageConfigurationInput
DescribeMediaStorageConfigurationOutput
DescribeNotificationConfigurationInput
DescribeNotificationConfigurationOutput
DescribeSignalingChannelInput
DescribeSignalingChannelOutput
DescribeStreamInput
DescribeStreamOutput
EdgeConfig

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.

GetDataEndpointInput
GetDataEndpointOutput
GetSignalingChannelEndpointInput
GetSignalingChannelEndpointOutput
ImageGenerationConfiguration

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

ImageGenerationDestinationConfig

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

ListSignalingChannelsInput
ListSignalingChannelsOutput
ListStreamsInput
ListStreamsOutput
ListTagsForResourceInput
ListTagsForResourceOutput
ListTagsForStreamInput
ListTagsForStreamOutput
LocalSizeConfig

The configuration details that include the maximum size of the media (MaxLocalMediaSizeInMB) that you want to store for a stream on the Edge Agent, as well as the strategy that should be used (StrategyOnFullSize) when a stream's maximum size has been reached.

MappedResourceConfigurationListItem

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

MediaSourceConfig

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

MediaStorageConfiguration

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

NotificationConfiguration

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

NotificationDestinationConfig

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

RecorderConfig

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

ResourceEndpointListItem

An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

ScheduleConfig

This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the DurationInMinutes attributes.

SingleMasterChannelEndpointConfiguration

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

SingleMasterConfiguration

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

StartEdgeConfigurationUpdateInput
StartEdgeConfigurationUpdateOutput
StreamInfo

An object describing a Kinesis video stream.

StreamNameCondition

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.

Tag

A key and value pair that is associated with the specified signaling channel.

TagResourceInput
TagStreamInput
UntagResourceInput
UntagStreamInput
UpdateDataRetentionInput
UpdateImageGenerationConfigurationInput
UpdateMediaStorageConfigurationInput
UpdateNotificationConfigurationInput
UpdateSignalingChannelInput
UpdateStreamInput
UploaderConfig

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

§Type Aliases

APIName
ChannelProtocol
ChannelRole
ChannelType
ComparisonOperator
ConfigurationStatus
Format
FormatConfigKey
ImageSelectorType
MediaStorageConfigurationStatus
MediaUriType
Status
StrategyOnFullSize
SyncStatus
UpdateDataRetentionOperation