@Generated(value="software.amazon.awssdk:codegen") public interface KinesisVideoClient extends SdkClient
builder() method.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static KinesisVideoClientBuilder |
builder()
Create a builder that can be used to configure and create a
KinesisVideoClient. |
static KinesisVideoClient |
create()
Create a
KinesisVideoClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateSignalingChannelResponse |
createSignalingChannel(Consumer<CreateSignalingChannelRequest.Builder> createSignalingChannelRequest)
Creates a signaling channel.
|
default CreateSignalingChannelResponse |
createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
Creates a signaling channel.
|
default CreateStreamResponse |
createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
Creates a new Kinesis video stream.
|
default CreateStreamResponse |
createStream(CreateStreamRequest createStreamRequest)
Creates a new Kinesis video stream.
|
default DeleteSignalingChannelResponse |
deleteSignalingChannel(Consumer<DeleteSignalingChannelRequest.Builder> deleteSignalingChannelRequest)
Deletes a specified signaling channel.
|
default DeleteSignalingChannelResponse |
deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
Deletes a specified signaling channel.
|
default DeleteStreamResponse |
deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
|
default DeleteStreamResponse |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
|
default DescribeSignalingChannelResponse |
describeSignalingChannel(Consumer<DescribeSignalingChannelRequest.Builder> describeSignalingChannelRequest)
Returns the most current information about the signaling channel.
|
default DescribeSignalingChannelResponse |
describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
Returns the most current information about the signaling channel.
|
default DescribeStreamResponse |
describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Returns the most current information about the specified stream.
|
default DescribeStreamResponse |
describeStream(DescribeStreamRequest describeStreamRequest)
Returns the most current information about the specified stream.
|
default GetDataEndpointResponse |
getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing.
|
default GetDataEndpointResponse |
getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing.
|
default GetSignalingChannelEndpointResponse |
getSignalingChannelEndpoint(Consumer<GetSignalingChannelEndpointRequest.Builder> getSignalingChannelEndpointRequest)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
default GetSignalingChannelEndpointResponse |
getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
default ListSignalingChannelsResponse |
listSignalingChannels(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)
Returns an array of
ChannelInfo objects. |
default ListSignalingChannelsResponse |
listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
Returns an array of
ChannelInfo objects. |
default ListSignalingChannelsIterable |
listSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)
Returns an array of
ChannelInfo objects. |
default ListSignalingChannelsIterable |
listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest)
Returns an array of
ChannelInfo objects. |
default ListStreamsResponse |
listStreams()
Returns an array of
StreamInfo objects. |
default ListStreamsResponse |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListStreamsResponse |
listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListStreamsIterable |
listStreamsPaginator()
Returns an array of
StreamInfo objects. |
default ListStreamsIterable |
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListStreamsIterable |
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
|
default ListTagsForStreamResponse |
listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
|
default ListTagsForStreamResponse |
listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to a signaling channel.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to a signaling channel.
|
default TagStreamResponse |
tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest)
Adds one or more tags to a stream.
|
default TagStreamResponse |
tagStream(TagStreamRequest tagStreamRequest)
Adds one or more tags to a stream.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from a signaling channel.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a signaling channel.
|
default UntagStreamResponse |
untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest)
Removes one or more tags from a stream.
|
default UntagStreamResponse |
untagStream(UntagStreamRequest untagStreamRequest)
Removes one or more tags from a stream.
|
default UpdateDataRetentionResponse |
updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify.
|
default UpdateDataRetentionResponse |
updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify.
|
default UpdateSignalingChannelResponse |
updateSignalingChannel(Consumer<UpdateSignalingChannelRequest.Builder> updateSignalingChannelRequest)
Updates the existing signaling channel.
|
default UpdateSignalingChannelResponse |
updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
Updates the existing signaling channel.
|
default UpdateStreamResponse |
updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)
Updates stream metadata, such as the device name and media type.
|
default UpdateStreamResponse |
updateStream(UpdateStreamRequest updateStreamRequest)
Updates stream metadata, such as the device name and media type.
|
serviceNameclosestatic final String SERVICE_NAME
static KinesisVideoClient create()
KinesisVideoClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KinesisVideoClientBuilder builder()
KinesisVideoClient.default CreateSignalingChannelResponse createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, AccountChannelLimitExceededException, ResourceInUseException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSignalingChannelResponse createSignalingChannel(Consumer<CreateSignalingChannelRequest.Builder> createSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, AccountChannelLimitExceededException, ResourceInUseException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Creates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
This is a convenience which creates an instance of the CreateSignalingChannelRequest.Builder avoiding the
need to create one manually via CreateSignalingChannelRequest.builder()
createSignalingChannelRequest - A Consumer that will call methods on CreateSignalingChannelInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStreamResponse createStream(CreateStreamRequest createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStreamResponse createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the CreateStreamRequest.Builder avoiding the need to
create one manually via CreateStreamRequest.builder()
createStreamRequest - A Consumer that will call methods on CreateStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSignalingChannelResponse deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSignalingChannelResponse deleteSignalingChannel(Consumer<DeleteSignalingChannelRequest.Builder> deleteSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the DeleteSignalingChannelRequest.Builder avoiding the
need to create one manually via DeleteSignalingChannelRequest.builder()
deleteSignalingChannelRequest - A Consumer that will call methods on DeleteSignalingChannelInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStreamResponse deleteStream(DeleteStreamRequest deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStreamResponse deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the DeleteStreamRequest.Builder avoiding the need to
create one manually via DeleteStreamRequest.builder()
deleteStreamRequest - A Consumer that will call methods on DeleteStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSignalingChannelResponse describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSignalingChannelResponse describeSignalingChannel(Consumer<DescribeSignalingChannelRequest.Builder> describeSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the DescribeSignalingChannelRequest.Builder avoiding
the need to create one manually via DescribeSignalingChannelRequest.builder()
describeSignalingChannelRequest - A Consumer that will call methods on DescribeSignalingChannelInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest - A Consumer that will call methods on DescribeStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataEndpointResponse getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataEndpointResponse getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the GetDataEndpointRequest.Builder avoiding the need
to create one manually via GetDataEndpointRequest.builder()
getDataEndpointRequest - A Consumer that will call methods on GetDataEndpointInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSignalingChannelEndpointResponse getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSignalingChannelEndpointResponse getSignalingChannelEndpoint(Consumer<GetSignalingChannelEndpointRequest.Builder> getSignalingChannelEndpointRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the GetSignalingChannelEndpointRequest.Builder
avoiding the need to create one manually via GetSignalingChannelEndpointRequest.builder()
getSignalingChannelEndpointRequest - A Consumer that will call methods on GetSignalingChannelEndpointInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSignalingChannelsResponse listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSignalingChannelsResponse listSignalingChannels(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the ListSignalingChannelsRequest.Builder avoiding the
need to create one manually via ListSignalingChannelsRequest.builder()
listSignalingChannelsRequest - A Consumer that will call methods on ListSignalingChannelsInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSignalingChannelsIterable listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client
.listSignalingChannelsPaginator(request);
for (software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSignalingChannelsIterable listSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client
.listSignalingChannelsPaginator(request);
for (software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation.
This is a convenience which creates an instance of the ListSignalingChannelsRequest.Builder avoiding the
need to create one manually via ListSignalingChannelsRequest.builder()
listSignalingChannelsRequest - A Consumer that will call methods on ListSignalingChannelsInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStreamsResponse listStreams() throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStreams(ListStreamsRequest),
AWS API
Documentationdefault ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStreamsIterable listStreamsPaginator() throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStreamsPaginator(ListStreamsRequest),
AWS API
Documentationdefault ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified signaling channel.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForStreamResponse listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForStreamResponse listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
This is a convenience which creates an instance of the ListTagsForStreamRequest.Builder avoiding the need
to create one manually via ListTagsForStreamRequest.builder()
listTagsForStreamRequest - A Consumer that will call methods on ListTagsForStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagStreamResponse tagStream(TagStreamRequest tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagStreamResponse tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the TagStreamRequest.Builder avoiding the need to
create one manually via TagStreamRequest.builder()
tagStreamRequest - A Consumer that will call methods on TagStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagStreamResponse untagStream(UntagStreamRequest untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagStreamResponse untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the UntagStreamRequest.Builder avoiding the need to
create one manually via UntagStreamRequest.builder()
untagStreamRequest - A Consumer that will call methods on UntagStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataRetentionResponse updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataRetentionResponse updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the UpdateDataRetentionRequest.Builder avoiding the
need to create one manually via UpdateDataRetentionRequest.builder()
updateDataRetentionRequest - A Consumer that will call methods on UpdateDataRetentionInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSignalingChannelResponse updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSignalingChannelResponse updateSignalingChannel(Consumer<UpdateSignalingChannelRequest.Builder> updateSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the UpdateSignalingChannelRequest.Builder avoiding the
need to create one manually via UpdateSignalingChannelRequest.builder()
updateSignalingChannelRequest - A Consumer that will call methods on UpdateSignalingChannelInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStreamResponse updateStream(UpdateStreamRequest updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStreamResponse updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
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.
This is a convenience which creates an instance of the UpdateStreamRequest.Builder avoiding the need to
create one manually via UpdateStreamRequest.builder()
updateStreamRequest - A Consumer that will call methods on UpdateStreamInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.