Amazon Web Services, Inc.

Amazon Kinesis Video Streams

Amazon Kinesis Video Streams endpoints from Amazon Web Services, Inc.

Media & content#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

<p></p>

Endpoints 32

  • POSTCreate signaling channel/createSignalingChannelCreates a signaling channel. CreateSignalingChannel is an asynchronous operation.
  • POSTCreate stream/createStreamCreates 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,…
  • POSTDelete edge configuration/deleteEdgeConfigurationAn asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. When you invoke this API, the…
  • POSTDelete signaling channel/deleteSignalingChannelDeletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most…
  • POSTDelete stream/deleteStreamDeletes 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…
  • POSTDescribe edge configuration/describeEdgeConfigurationDescribes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and…
  • POSTDescribe image generation configuration/describeImageGenerationConfigurationGets the ImageGenerationConfiguration for a given Kinesis video stream.
  • POSTDescribe mapped resource configuration/describeMappedResourceConfigurationReturns the most current information about the stream. The streamName or streamARN should be provided in the input.
  • POSTDescribe media storage configuration/describeMediaStorageConfigurationReturns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.
  • POSTDescribe notification configuration/describeNotificationConfigurationGets the NotificationConfiguration for a given Kinesis video stream.
  • POSTDescribe signaling channel/describeSignalingChannelReturns 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…
  • POSTDescribe stream/describeStreamReturns the most current information about the specified stream. You must specify either the StreamName or the StreamARN .
  • POSTDescribe stream storage configuration/describeStreamStorageConfigurationRetrieves the current storage configuration for the specified Kinesis video stream. In the request, you must specify either the StreamName or the StreamARN .…
  • POSTGet data endpoint/getDataEndpointGets 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…
  • POSTGet signaling channel endpoint/getSignalingChannelEndpointProvides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input…
  • POSTList edge agent configurations/listEdgeAgentConfigurationsReturns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn .
  • POSTList signaling channels/listSignalingChannelsReturns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can…
  • POSTList streams/listStreamsReturns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a…
  • POSTList tags for resource/ListTagsForResourceReturns a list of tags associated with the specified signaling channel.
  • POSTList tags for stream/listTagsForStreamReturns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN .
  • POSTStart edge configuration update/startEdgeConfigurationUpdateAn asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge…
  • POSTTag resource/TagResourceAdds 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…
  • POSTTag stream/tagStreamAdds 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…
  • POSTUntag resource/UntagResourceRemoves 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…
  • POSTUntag stream/untagStreamRemoves 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,…
  • POSTUpdate data retention/updateDataRetentionIncreases 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…
  • POSTUpdate image generation configuration/updateImageGenerationConfigurationUpdates the StreamInfo and ImageProcessingConfiguration fields.
  • POSTUpdate media storage configuration/updateMediaStorageConfigurationAssociates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify : If StorageStatus is enabled, the data will…
  • POSTUpdate notification configuration/updateNotificationConfigurationUpdates the notification information for a stream.
  • POSTUpdate signaling channel/updateSignalingChannelUpdates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either…
  • POSTUpdate stream/updateStreamUpdates 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…
  • POSTUpdate stream storage configuration/updateStreamStorageConfigurationUpdates the storage configuration for an existing Kinesis video stream. This operation allows you to modify the storage tier settings for a stream, enabling…

API details

Base URL
https://kinesisvideo.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
32 operations on 32 pathsPOST 32
Description format
AWS Smithy model, API version 2017-09-30

How to test the Amazon Kinesis Video Streams in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Kinesis Video Streams collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create signaling channel” (POST /createSignalingChannel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Kinesis Video Streams?

Amazon Kinesis Video Streams endpoints from Amazon Web Services, Inc. It is listed under Media & content and has 32 endpoints.

Who publishes the Amazon Kinesis Video Streams?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Kinesis Video Streams?

Requests go to https://kinesisvideo.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Kinesis Video Streams?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Kinesis Video Streams have?

32 operations on 32 paths (32 POST).

Is forking the Amazon Kinesis Video Streams free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.