@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisVideo
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonKinesisVideo
instead.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateSignalingChannelResult |
createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
Creates a signaling channel.
|
CreateStreamResult |
createStream(CreateStreamRequest createStreamRequest)
Creates a new Kinesis video stream.
|
DeleteSignalingChannelResult |
deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
Deletes a specified signaling channel.
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
|
DescribeSignalingChannelResult |
describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
Returns the most current information about the signaling channel.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest describeStreamRequest)
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 getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing.
|
GetSignalingChannelEndpointResult |
getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
ListSignalingChannelsResult |
listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
Returns an array of
ChannelInfo objects. |
ListStreamsResult |
listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of
StreamInfo objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
|
ListTagsForStreamResult |
listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
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 tagResourceRequest)
Adds one or more tags to a signaling channel.
|
TagStreamResult |
tagStream(TagStreamRequest tagStreamRequest)
Adds one or more tags to a stream.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a signaling channel.
|
UntagStreamResult |
untagStream(UntagStreamRequest untagStreamRequest)
Removes one or more tags from a stream.
|
UpdateDataRetentionResult |
updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify.
|
UpdateSignalingChannelResult |
updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
Updates the existing signaling channel.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest updateStreamRequest)
Updates stream metadata, such as the device name and media type.
|
static final String ENDPOINT_PREFIX
CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
createSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.AccountChannelLimitExceededException
- You have reached the maximum limit of active signaling channels for this AWS account in this region.ResourceInUseException
- The signaling channel is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.CreateStreamResult createStream(CreateStreamRequest createStreamRequest)
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.
createStreamRequest
- AccountStreamLimitExceededException
- The number of streams created for the account is too high.DeviceStreamLimitExceededException
- Not implemented.ResourceInUseException
- The signaling channel is currently not available for this operation.InvalidDeviceException
- Not implemented.InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
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.
deleteSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.ResourceInUseException
- The signaling channel is currently not available for this operation.DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)
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.
deleteStreamRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException
- The caller is not authorized to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.ResourceInUseException
- The signaling channel is currently not available for this operation.DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
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.
describeSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)
Returns the most current information about the specified stream. You must specify either the
StreamName
or the StreamARN
.
describeStreamRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.NotAuthorizedException
- The caller is not authorized to perform this operation.GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
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
.
getDataEndpointRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.NotAuthorizedException
- The caller is not authorized to perform this operation.GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
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
.
getSignalingChannelEndpointRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The signaling channel is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
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
.
listSignalingChannelsRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.AccessDeniedException
- You do not have required permissions to perform this operation.ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
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
.
listStreamsRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
listTagsForResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the StreamARN
.
listTagsForStreamRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException
- The caller is not authorized to perform this operation.InvalidResourceFormatException
- The format of the StreamARN
is invalid.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.TagStreamResult tagStream(TagStreamRequest tagStreamRequest)
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.
tagStreamRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException
- The caller is not authorized to perform this operation.InvalidResourceFormatException
- The format of the StreamARN
is invalid.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.UntagStreamResult untagStream(UntagStreamRequest untagStreamRequest)
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
.
untagStreamRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException
- The caller is not authorized to perform this operation.InvalidResourceFormatException
- The format of the StreamARN
is invalid.UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
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.
updateDataRetentionRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The signaling channel is currently not available for this operation.NotAuthorizedException
- The caller is not authorized to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
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.
updateSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The signaling channel is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest)
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.
updateStreamRequest
- ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.InvalidArgumentException
- The value for this input parameter is invalid.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The signaling channel is currently not available for this operation.NotAuthorizedException
- The caller is not authorized to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2021. All rights reserved.