KinesisVideo

import { KinesisVideo } from "https://aws-api.deno.dev/v0.4/services/kinesisvideo.ts?docs=full";

class KinesisVideo {

constructor(apiFactory: client.ApiFactory);

async createSignalingChannel(params: CreateSignalingChannelInput, opts?: client.RequestOptions): Promise<CreateSignalingChannelOutput>;

async createStream(params: CreateStreamInput, opts?: client.RequestOptions): Promise<CreateStreamOutput>;

async deleteSignalingChannel(params: DeleteSignalingChannelInput, opts?: client.RequestOptions): Promise<void>;

async deleteStream(params: DeleteStreamInput, opts?: client.RequestOptions): Promise<void>;

async describeEdgeConfiguration(params?: DescribeEdgeConfigurationInput, opts?: client.RequestOptions): Promise<DescribeEdgeConfigurationOutput>;

async describeImageGenerationConfiguration(params?: DescribeImageGenerationConfigurationInput, opts?: client.RequestOptions): Promise<DescribeImageGenerationConfigurationOutput>;

async describeMappedResourceConfiguration(params?: DescribeMappedResourceConfigurationInput, opts?: client.RequestOptions): Promise<DescribeMappedResourceConfigurationOutput>;

async describeMediaStorageConfiguration(params?: DescribeMediaStorageConfigurationInput, opts?: client.RequestOptions): Promise<DescribeMediaStorageConfigurationOutput>;

async describeNotificationConfiguration(params?: DescribeNotificationConfigurationInput, opts?: client.RequestOptions): Promise<DescribeNotificationConfigurationOutput>;

async describeSignalingChannel(params?: DescribeSignalingChannelInput, opts?: client.RequestOptions): Promise<DescribeSignalingChannelOutput>;

async describeStream(params?: DescribeStreamInput, opts?: client.RequestOptions): Promise<DescribeStreamOutput>;

async getDataEndpoint(params: GetDataEndpointInput, opts?: client.RequestOptions): Promise<GetDataEndpointOutput>;

async getSignalingChannelEndpoint(params: GetSignalingChannelEndpointInput, opts?: client.RequestOptions): Promise<GetSignalingChannelEndpointOutput>;

async listSignalingChannels(params?: ListSignalingChannelsInput, opts?: client.RequestOptions): Promise<ListSignalingChannelsOutput>;

async listStreams(params?: ListStreamsInput, opts?: client.RequestOptions): Promise<ListStreamsOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async listTagsForStream(params?: ListTagsForStreamInput, opts?: client.RequestOptions): Promise<ListTagsForStreamOutput>;

async startEdgeConfigurationUpdate(params: StartEdgeConfigurationUpdateInput, opts?: client.RequestOptions): Promise<StartEdgeConfigurationUpdateOutput>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async tagStream(params: TagStreamInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

async untagStream(params: UntagStreamInput, opts?: client.RequestOptions): Promise<void>;

async updateDataRetention(params: UpdateDataRetentionInput, opts?: client.RequestOptions): Promise<void>;

async updateImageGenerationConfiguration(params?: UpdateImageGenerationConfigurationInput, opts?: client.RequestOptions): Promise<void>;

async updateMediaStorageConfiguration(params: UpdateMediaStorageConfigurationInput, opts?: client.RequestOptions): Promise<void>;

async updateNotificationConfiguration(params?: UpdateNotificationConfigurationInput, opts?: client.RequestOptions): Promise<void>;

async updateSignalingChannel(params: UpdateSignalingChannelInput, opts?: client.RequestOptions): Promise<void>;

async updateStream(params: UpdateStreamInput, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new KinesisVideo(apiFactory: client.ApiFactory)

[src]

§Methods

createSignalingChannel(params: CreateSignalingChannelInput, opts?: client.RequestOptions): Promise<CreateSignalingChannelOutput>

[src]

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

createStream(params: CreateStreamInput, opts?: client.RequestOptions): Promise<CreateStreamOutput>

[src]

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

deleteSignalingChannel(params: DeleteSignalingChannelInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.

deleteStream(params: DeleteStreamInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

describeEdgeConfiguration(params?: DescribeEdgeConfigurationInput, opts?: client.RequestOptions): Promise<DescribeEdgeConfigurationOutput>

[src]

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.

describeImageGenerationConfiguration(params?: DescribeImageGenerationConfigurationInput, opts?: client.RequestOptions): Promise<DescribeImageGenerationConfigurationOutput>

[src]

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

describeMappedResourceConfiguration(params?: DescribeMappedResourceConfigurationInput, opts?: client.RequestOptions): Promise<DescribeMappedResourceConfigurationOutput>

[src]

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

describeMediaStorageConfiguration(params?: DescribeMediaStorageConfigurationInput, opts?: client.RequestOptions): Promise<DescribeMediaStorageConfigurationOutput>

[src]

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

describeNotificationConfiguration(params?: DescribeNotificationConfigurationInput, opts?: client.RequestOptions): Promise<DescribeNotificationConfigurationOutput>

[src]

Gets the NotificationConfiguration for a given Kinesis video stream.

describeSignalingChannel(params?: DescribeSignalingChannelInput, opts?: client.RequestOptions): Promise<DescribeSignalingChannelOutput>

[src]

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

describeStream(params?: DescribeStreamInput, opts?: client.RequestOptions): Promise<DescribeStreamOutput>

[src]

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

getDataEndpoint(params: GetDataEndpointInput, opts?: client.RequestOptions): Promise<GetDataEndpointOutput>

[src]

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

Note: The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

getSignalingChannelEndpoint(params: GetSignalingChannelEndpointInput, opts?: client.RequestOptions): Promise<GetSignalingChannelEndpointOutput>

[src]

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

listSignalingChannels(params?: ListSignalingChannelsInput, opts?: client.RequestOptions): Promise<ListSignalingChannelsOutput>

[src]

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

listStreams(params?: ListStreamsInput, opts?: client.RequestOptions): Promise<ListStreamsOutput>

[src]

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

Returns a list of tags associated with the specified signaling channel.

listTagsForStream(params?: ListTagsForStreamInput, opts?: client.RequestOptions): Promise<ListTagsForStreamOutput>

[src]

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

startEdgeConfigurationUpdate(params: StartEdgeConfigurationUpdateInput, opts?: client.RequestOptions): Promise<StartEdgeConfigurationUpdateOutput>

[src]

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.

tagStream(params: TagStreamInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

A Kinesis video stream can support up to 50 tags.

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

untagStream(params: UntagStreamInput, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

updateDataRetention(params: UpdateDataRetentionInput, opts?: client.RequestOptions): Promise<void>

[src]

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

Note: The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

updateImageGenerationConfiguration(params?: UpdateImageGenerationConfigurationInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the StreamInfo and ImageProcessingConfiguration fields.

updateMediaStorageConfiguration(params: UpdateMediaStorageConfigurationInput, opts?: client.RequestOptions): Promise<void>

[src]

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.
If the StorageStatus is enabled, the data will be stored in the StreamARN provided.

updateNotificationConfiguration(params?: UpdateNotificationConfigurationInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the notification information for a stream.

updateSignalingChannel(params: UpdateSignalingChannelInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

updateStream(params: UpdateStreamInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]