deleteStream

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.

Parameters:

deleteStreamRequest -

Returns:

Result of the DeleteStream operation returned by the service.

Throws:

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.

getDataEndpoint

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.

getSignalingChannelEndpoint

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.

Parameters:

getSignalingChannelEndpointRequest -

Returns:

Result of the GetSignalingChannelEndpoint operation returned by the service.

tagResource

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.

tagStream

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.

Kinesis video streams support up to 50 tags.

Parameters:

tagStreamRequest -

Returns:

Result of the TagStream operation returned by the service.

Throws:

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.

updateDataRetention

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.

Parameters:

updateDataRetentionRequest -

Returns:

Result of the UpdateDataRetention operation returned by the service.

Throws:

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.

updateSignalingChannel

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.

Parameters:

updateSignalingChannelRequest -

Returns:

Result of the UpdateSignalingChannel operation returned by the service.

updateStream

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.

Parameters:

updateStreamRequest -

Returns:

Result of the UpdateStream operation returned by the service.

Throws:

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected. This data isn't considered part of the result data returned by an
operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
information for an executed request, you should use this method to retrieve it as soon as possible after
executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.