@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonKinesisVideo extends Object implements AmazonKinesisVideo
AmazonKinesisVideo. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CreateSignalingChannelResult |
createSignalingChannel(CreateSignalingChannelRequest request)
Creates a signaling channel.
|
CreateStreamResult |
createStream(CreateStreamRequest request)
Creates a new Kinesis video stream.
|
DeleteSignalingChannelResult |
deleteSignalingChannel(DeleteSignalingChannelRequest request)
Deletes a specified signaling channel.
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest request)
Deletes a Kinesis video stream and the data contained in the stream.
|
DescribeSignalingChannelResult |
describeSignalingChannel(DescribeSignalingChannelRequest request)
Returns the most current information about the signaling channel.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest request)
Returns the most current information about the specified stream.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataEndpointResult |
getDataEndpoint(GetDataEndpointRequest request)
Gets an endpoint for a specified stream for either reading or writing.
|
GetSignalingChannelEndpointResult |
getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
ListSignalingChannelsResult |
listSignalingChannels(ListSignalingChannelsRequest request)
Returns an array of
ChannelInfo objects. |
ListStreamsResult |
listStreams(ListStreamsRequest request)
Returns an array of
StreamInfo objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with the specified signaling channel.
|
ListTagsForStreamResult |
listTagsForStream(ListTagsForStreamRequest request)
Returns a list of tags associated with the specified stream.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a signaling channel.
|
TagStreamResult |
tagStream(TagStreamRequest request)
Adds one or more tags to a stream.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a signaling channel.
|
UntagStreamResult |
untagStream(UntagStreamRequest request)
Removes one or more tags from a stream.
|
UpdateDataRetentionResult |
updateDataRetention(UpdateDataRetentionRequest request)
Increases or decreases the stream's data retention period by the value that you specify.
|
UpdateSignalingChannelResult |
updateSignalingChannel(UpdateSignalingChannelRequest request)
Updates the existing signaling channel.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest request)
Updates stream metadata, such as the device name and media type.
|
public CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest request)
AmazonKinesisVideoCreates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
createSignalingChannel in interface AmazonKinesisVideopublic CreateStreamResult createStream(CreateStreamRequest request)
AmazonKinesisVideoCreates 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.
createStream in interface AmazonKinesisVideopublic DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest request)
AmazonKinesisVideo
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.
deleteSignalingChannel in interface AmazonKinesisVideopublic DeleteStreamResult deleteStream(DeleteStreamRequest request)
AmazonKinesisVideoDeletes 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.
deleteStream in interface AmazonKinesisVideopublic DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest request)
AmazonKinesisVideoReturns 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.
describeSignalingChannel in interface AmazonKinesisVideopublic DescribeStreamResult describeStream(DescribeStreamRequest request)
AmazonKinesisVideo
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
describeStream in interface AmazonKinesisVideopublic GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest request)
AmazonKinesisVideo
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 by StreamName or StreamARN.
getDataEndpoint in interface AmazonKinesisVideopublic GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
AmazonKinesisVideo
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.
getSignalingChannelEndpoint in interface AmazonKinesisVideopublic ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest request)
AmazonKinesisVideo
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.
listSignalingChannels in interface AmazonKinesisVideopublic ListStreamsResult listStreams(ListStreamsRequest request)
AmazonKinesisVideo
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.
listStreams in interface AmazonKinesisVideopublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonKinesisVideoReturns a list of tags associated with the specified signaling channel.
listTagsForResource in interface AmazonKinesisVideopublic ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest request)
AmazonKinesisVideoReturns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
listTagsForStream in interface AmazonKinesisVideopublic TagResourceResult tagResource(TagResourceRequest request)
AmazonKinesisVideoAdds 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.
tagResource in interface AmazonKinesisVideopublic TagStreamResult tagStream(TagStreamRequest request)
AmazonKinesisVideoAdds 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.
tagStream in interface AmazonKinesisVideopublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonKinesisVideoRemoves 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.
untagResource in interface AmazonKinesisVideopublic UntagStreamResult untagStream(UntagStreamRequest request)
AmazonKinesisVideoRemoves 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.
untagStream in interface AmazonKinesisVideopublic UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest request)
AmazonKinesisVideo
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.
updateDataRetention in interface AmazonKinesisVideopublic UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest request)
AmazonKinesisVideoUpdates 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.
updateSignalingChannel in interface AmazonKinesisVideopublic UpdateStreamResult updateStream(UpdateStreamRequest request)
AmazonKinesisVideoUpdates 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.
updateStream in interface AmazonKinesisVideopublic void shutdown()
AmazonKinesisVideoshutdown in interface AmazonKinesisVideopublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonKinesisVideoResponse 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.
getCachedResponseMetadata in interface AmazonKinesisVideorequest - The originally executed request.