aws_kinesis_video
Summary
Functions
-
create_signaling_channel(Client, Input)
Creates a signaling channel.
- create_signaling_channel(Client, Input0, Options0)
-
create_stream(Client, Input)
Creates a new Kinesis video stream.
- create_stream(Client, Input0, Options0)
-
delete_signaling_channel(Client, Input)
Deletes a specified signaling channel.
- delete_signaling_channel(Client, Input0, Options0)
-
delete_stream(Client, Input)
Deletes a Kinesis video stream and the data contained in the stream.
- delete_stream(Client, Input0, Options0)
-
describe_signaling_channel(Client, Input)
Returns the most current information about the signaling channel.
- describe_signaling_channel(Client, Input0, Options0)
-
describe_stream(Client, Input)
Returns the most current information about the specified stream.
- describe_stream(Client, Input0, Options0)
-
get_data_endpoint(Client, Input)
Gets an endpoint for a specified stream for either reading or writing.
- get_data_endpoint(Client, Input0, Options0)
-
get_signaling_channel_endpoint(Client, Input)
Provides an endpoint for the specified signaling channel to send and receive messages.
- get_signaling_channel_endpoint(Client, Input0, Options0)
-
list_signaling_channels(Client, Input)
Returns an array of
ChannelInfo
objects. - list_signaling_channels(Client, Input0, Options0)
-
list_streams(Client, Input)
Returns an array of
StreamInfo
objects. - list_streams(Client, Input0, Options0)
-
list_tags_for_resource(Client, Input)
Returns a list of tags associated with the specified signaling channel.
- list_tags_for_resource(Client, Input0, Options0)
-
list_tags_for_stream(Client, Input)
Returns a list of tags associated with the specified stream.
- list_tags_for_stream(Client, Input0, Options0)
-
tag_resource(Client, Input)
Adds one or more tags to a signaling channel.
- tag_resource(Client, Input0, Options0)
-
tag_stream(Client, Input)
Adds one or more tags to a stream.
- tag_stream(Client, Input0, Options0)
-
untag_resource(Client, Input)
Removes one or more tags from a signaling channel.
- untag_resource(Client, Input0, Options0)
-
untag_stream(Client, Input)
Removes one or more tags from a stream.
- untag_stream(Client, Input0, Options0)
-
update_data_retention(Client, Input)
Increases or decreases the stream's data retention period by the value that you specify.
- update_data_retention(Client, Input0, Options0)
-
update_signaling_channel(Client, Input)
Updates the existing signaling channel.
- update_signaling_channel(Client, Input0, Options0)
-
update_stream(Client, Input)
Updates stream metadata, such as the device name and media type.
- update_stream(Client, Input0, Options0)
Functions
create_signaling_channel(Client, Input)
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
create_signaling_channel(Client, Input0, Options0)
create_stream(Client, Input)
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 theKinesisVideo:CreateStream
action.
create_stream(Client, Input0, Options0)
delete_signaling_channel(Client, Input)
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.
delete_signaling_channel(Client, Input0, Options0)
delete_stream(Client, Input)
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.
KinesisVideo:DeleteStream
action.
delete_stream(Client, Input0, Options0)
describe_signaling_channel(Client, Input)
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.describe_signaling_channel(Client, Input0, Options0)
describe_stream(Client, Input)
Returns the most current information about the specified stream.
You must specify either theStreamName
or the StreamARN
.
describe_stream(Client, Input0, Options0)
get_data_endpoint(Client, Input)
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).
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 byStreamName
or StreamARN
.
get_data_endpoint(Client, Input0, Options0)
get_signaling_channel_endpoint(Client, Input)
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
.
get_signaling_channel_endpoint(Client, Input0, Options0)
list_signaling_channels(Client, Input)
Returns an array of ChannelInfo
objects.
ChannelNameCondition
.
list_signaling_channels(Client, Input0, Options0)
list_streams(Client, Input)
Returns an array of StreamInfo
objects.
StreamNameCondition
.
list_streams(Client, Input0, Options0)
list_tags_for_resource(Client, Input)
Returns a list of tags associated with the specified signaling channel.
list_tags_for_resource(Client, Input0, Options0)
list_tags_for_stream(Client, Input)
Returns a list of tags associated with the specified stream.
In the request, you must specify either theStreamName
or the
StreamARN
.
list_tags_for_stream(Client, Input0, Options0)
tag_resource(Client, Input)
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 AWS 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 AWS Billing and Cost Management User Guide.tag_resource(Client, Input0, Options0)
tag_stream(Client, Input)
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 AWS 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 AWS Billing and Cost Management User Guide.
You must provide either the StreamName
or the StreamARN
.
This operation requires permission for the KinesisVideo:TagStream
action.
tag_stream(Client, Input0, Options0)
untag_resource(Client, Input)
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.untag_resource(Client, Input0, Options0)
untag_stream(Client, Input)
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 theStreamName
or StreamARN
.
untag_stream(Client, Input0, Options0)
update_data_retention(Client, Input)
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
.
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.
update_data_retention(Client, Input0, Options0)
update_signaling_channel(Client, Input)
Updates the existing signaling channel.
This is an asynchronous operation and takes time to complete.
If theMessageTtlSeconds
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.
update_signaling_channel(Client, Input0, Options0)
update_stream(Client, Input)
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.