Interface KinesisVideoClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface KinesisVideoClient
extends AwsClient

Service client for accessing Kinesis Video. This can be created using the static builder() method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 DeleteEdgeConfigurationResponse	deleteEdgeConfiguration(Consumer<DeleteEdgeConfigurationRequest.Builder> deleteEdgeConfigurationRequest)	An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.
default DeleteEdgeConfigurationResponse	deleteEdgeConfiguration(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest)	An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.
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 DescribeEdgeConfigurationResponse	describeEdgeConfiguration(Consumer<DescribeEdgeConfigurationRequest.Builder> describeEdgeConfigurationRequest)	Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs.
default DescribeEdgeConfigurationResponse	describeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest)	Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs.
default DescribeImageGenerationConfigurationResponse	describeImageGenerationConfiguration(Consumer<DescribeImageGenerationConfigurationRequest.Builder> describeImageGenerationConfigurationRequest)	Gets the ImageGenerationConfiguration for a given Kinesis video stream.
default DescribeImageGenerationConfigurationResponse	describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)	Gets the ImageGenerationConfiguration for a given Kinesis video stream.
default DescribeMappedResourceConfigurationResponse	describeMappedResourceConfiguration(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)	Returns the most current information about the stream.
default DescribeMappedResourceConfigurationResponse	describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)	Returns the most current information about the stream.
default DescribeMappedResourceConfigurationIterable	describeMappedResourceConfigurationPaginator(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)	This is a variant of describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) operation.
default DescribeMappedResourceConfigurationIterable	describeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)	This is a variant of describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) operation.
default DescribeMediaStorageConfigurationResponse	describeMediaStorageConfiguration(Consumer<DescribeMediaStorageConfigurationRequest.Builder> describeMediaStorageConfigurationRequest)	Returns the most current information about the channel.
default DescribeMediaStorageConfigurationResponse	describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)	Returns the most current information about the channel.
default DescribeNotificationConfigurationResponse	describeNotificationConfiguration(Consumer<DescribeNotificationConfigurationRequest.Builder> describeNotificationConfigurationRequest)	Gets the NotificationConfiguration for a given Kinesis video stream.
default DescribeNotificationConfigurationResponse	describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)	Gets the NotificationConfiguration for a given Kinesis video 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 ListEdgeAgentConfigurationsResponse	listEdgeAgentConfigurations(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)	Returns an array of edge configurations associated with the specified Edge Agent.
default ListEdgeAgentConfigurationsResponse	listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)	Returns an array of edge configurations associated with the specified Edge Agent.
default ListEdgeAgentConfigurationsIterable	listEdgeAgentConfigurationsPaginator(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)	This is a variant of listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) operation.
default ListEdgeAgentConfigurationsIterable	listEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)	This is a variant of listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) operation.
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)	This is a variant of listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest) operation.
default ListSignalingChannelsIterable	listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest)	This is a variant of listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest) operation.
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()	This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
default ListStreamsIterable	listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)	This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
default ListStreamsIterable	listStreamsPaginator(ListStreamsRequest listStreamsRequest)	This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
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.
default KinesisVideoServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartEdgeConfigurationUpdateResponse	startEdgeConfigurationUpdate(Consumer<StartEdgeConfigurationUpdateRequest.Builder> startEdgeConfigurationUpdateRequest)	An asynchronous API that updates a stream’s existing edge configuration.
default StartEdgeConfigurationUpdateResponse	startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)	An asynchronous API that updates a stream’s existing edge configuration.
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 UpdateImageGenerationConfigurationResponse	updateImageGenerationConfiguration(Consumer<UpdateImageGenerationConfigurationRequest.Builder> updateImageGenerationConfigurationRequest)	Updates the StreamInfo and ImageProcessingConfiguration fields.
default UpdateImageGenerationConfigurationResponse	updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)	Updates the StreamInfo and ImageProcessingConfiguration fields.
default UpdateMediaStorageConfigurationResponse	updateMediaStorageConfiguration(Consumer<UpdateMediaStorageConfigurationRequest.Builder> updateMediaStorageConfigurationRequest)	Associates a SignalingChannel to a stream to store the media.
default UpdateMediaStorageConfigurationResponse	updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)	Associates a SignalingChannel to a stream to store the media.
default UpdateNotificationConfigurationResponse	updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest)	Updates the notification information for a stream.
default UpdateNotificationConfigurationResponse	updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)	Updates the notification information for a stream.
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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createSignalingChannel

default CreateSignalingChannelResponse createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
                                                       throws InvalidArgumentException,
ClientLimitExceededException,
AccountChannelLimitExceededException,
ResourceInUseException,
AccessDeniedException,
TagsPerResourceExceededLimitException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Parameters:

createSignalingChannelRequest -

Returns:

Result of the CreateSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

createSignalingChannel

default 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()

Parameters:

createSignalingChannelRequest - A Consumer that will call methods on CreateSignalingChannelRequest.Builder to create a request.

Returns:

Result of the CreateSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

createStream

default 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.

Parameters:

createStreamRequest -

Returns:

Result of the CreateStream operation returned by the service.

See Also:

• AWS API Documentation

createStream

default 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()

Parameters:

createStreamRequest - A Consumer that will call methods on CreateStreamRequest.Builder to create a request.

Returns:

Result of the CreateStream operation returned by the service.

See Also:

• AWS API Documentation

deleteEdgeConfiguration

default DeleteEdgeConfigurationResponse deleteEdgeConfiguration(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest)
                                                         throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
ResourceNotFoundException,
StreamEdgeConfigurationNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.

When the deletion process has completed successfully, the edge configuration is no longer accessible.

Parameters:

deleteEdgeConfigurationRequest -

Returns:

Result of the DeleteEdgeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteEdgeConfiguration

default DeleteEdgeConfigurationResponse deleteEdgeConfiguration(Consumer<DeleteEdgeConfigurationRequest.Builder> deleteEdgeConfigurationRequest)
                                                         throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
ResourceNotFoundException,
StreamEdgeConfigurationNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.

When the deletion process has completed successfully, the edge configuration is no longer accessible.

This is a convenience which creates an instance of the DeleteEdgeConfigurationRequest.Builder avoiding the need to create one manually via DeleteEdgeConfigurationRequest.builder()

Parameters:

deleteEdgeConfigurationRequest - A Consumer that will call methods on DeleteEdgeConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteEdgeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteSignalingChannel

default 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.

Parameters:

deleteSignalingChannelRequest -

Returns:

Result of the DeleteSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteSignalingChannel

default 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()

Parameters:

deleteSignalingChannelRequest - A Consumer that will call methods on DeleteSignalingChannelRequest.Builder to create a request.

Returns:

Result of the DeleteSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteStream

default 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.

Parameters:

deleteStreamRequest -

Returns:

Result of the DeleteStream operation returned by the service.

See Also:

• AWS API Documentation

deleteStream

default 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()

Parameters:

deleteStreamRequest - A Consumer that will call methods on DeleteStreamRequest.Builder to create a request.

Returns:

Result of the DeleteStream operation returned by the service.

See Also:

• AWS API Documentation

describeEdgeConfiguration

default DescribeEdgeConfigurationResponse describeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest)
                                                             throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
ResourceNotFoundException,
StreamEdgeConfigurationNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.

Parameters:

describeEdgeConfigurationRequest -

Returns:

Result of the DescribeEdgeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeEdgeConfiguration

default DescribeEdgeConfigurationResponse describeEdgeConfiguration(Consumer<DescribeEdgeConfigurationRequest.Builder> describeEdgeConfigurationRequest)
                                                             throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
ResourceNotFoundException,
StreamEdgeConfigurationNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.

This is a convenience which creates an instance of the DescribeEdgeConfigurationRequest.Builder avoiding the need to create one manually via DescribeEdgeConfigurationRequest.builder()

Parameters:

describeEdgeConfigurationRequest - A Consumer that will call methods on DescribeEdgeConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeEdgeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeImageGenerationConfiguration

default DescribeImageGenerationConfigurationResponse describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)
                                                                                   throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

Parameters:

describeImageGenerationConfigurationRequest -

Returns:

Result of the DescribeImageGenerationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeImageGenerationConfiguration

default DescribeImageGenerationConfigurationResponse describeImageGenerationConfiguration(Consumer<DescribeImageGenerationConfigurationRequest.Builder> describeImageGenerationConfigurationRequest)
                                                                                   throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

This is a convenience which creates an instance of the DescribeImageGenerationConfigurationRequest.Builder avoiding the need to create one manually via DescribeImageGenerationConfigurationRequest.builder()

Parameters:

describeImageGenerationConfigurationRequest - A Consumer that will call methods on DescribeImageGenerationConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeImageGenerationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeMappedResourceConfiguration

default DescribeMappedResourceConfigurationResponse describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)
                                                                                 throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

Parameters:

describeMappedResourceConfigurationRequest -

Returns:

Result of the DescribeMappedResourceConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeMappedResourceConfiguration

default DescribeMappedResourceConfigurationResponse describeMappedResourceConfiguration(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)
                                                                                 throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

This is a convenience which creates an instance of the DescribeMappedResourceConfigurationRequest.Builder avoiding the need to create one manually via DescribeMappedResourceConfigurationRequest.builder()

Parameters:

describeMappedResourceConfigurationRequest - A Consumer that will call methods on DescribeMappedResourceConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeMappedResourceConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeMappedResourceConfigurationPaginator

default DescribeMappedResourceConfigurationIterable describeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)
                                                                                          throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

This is a variant of describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) 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.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client
             .describeMappedResourceConfigurationPaginator(request);
     for (software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(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 describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) operation.

Parameters:

describeMappedResourceConfigurationRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMappedResourceConfigurationPaginator

default DescribeMappedResourceConfigurationIterable describeMappedResourceConfigurationPaginator(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)
                                                                                          throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

This is a variant of describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) 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.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client
             .describeMappedResourceConfigurationPaginator(request);
     for (software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(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 describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest) operation.

This is a convenience which creates an instance of the DescribeMappedResourceConfigurationRequest.Builder avoiding the need to create one manually via DescribeMappedResourceConfigurationRequest.builder()

Parameters:

describeMappedResourceConfigurationRequest - A Consumer that will call methods on DescribeMappedResourceConfigurationRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeMediaStorageConfiguration

default DescribeMediaStorageConfigurationResponse describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)
                                                                             throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

Parameters:

describeMediaStorageConfigurationRequest -

Returns:

Result of the DescribeMediaStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeMediaStorageConfiguration

default DescribeMediaStorageConfigurationResponse describeMediaStorageConfiguration(Consumer<DescribeMediaStorageConfigurationRequest.Builder> describeMediaStorageConfigurationRequest)
                                                                             throws ResourceNotFoundException,
InvalidArgumentException,
AccessDeniedException,
ClientLimitExceededException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

This is a convenience which creates an instance of the DescribeMediaStorageConfigurationRequest.Builder avoiding the need to create one manually via DescribeMediaStorageConfigurationRequest.builder()

Parameters:

describeMediaStorageConfigurationRequest - A Consumer that will call methods on DescribeMediaStorageConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeMediaStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeNotificationConfiguration

default DescribeNotificationConfigurationResponse describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)
                                                                             throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Gets the NotificationConfiguration for a given Kinesis video stream.

Parameters:

describeNotificationConfigurationRequest -

Returns:

Result of the DescribeNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeNotificationConfiguration

default DescribeNotificationConfigurationResponse describeNotificationConfiguration(Consumer<DescribeNotificationConfigurationRequest.Builder> describeNotificationConfigurationRequest)
                                                                             throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Gets the NotificationConfiguration for a given Kinesis video stream.

This is a convenience which creates an instance of the DescribeNotificationConfigurationRequest.Builder avoiding the need to create one manually via DescribeNotificationConfigurationRequest.builder()

Parameters:

describeNotificationConfigurationRequest - A Consumer that will call methods on DescribeNotificationConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeSignalingChannel

default 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.

Parameters:

describeSignalingChannelRequest -

Returns:

Result of the DescribeSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

describeSignalingChannel

default 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()

Parameters:

describeSignalingChannelRequest - A Consumer that will call methods on DescribeSignalingChannelRequest.Builder to create a request.

Returns:

Result of the DescribeSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

describeStream

default 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.

Parameters:

describeStreamRequest -

Returns:

Result of the DescribeStream operation returned by the service.

See Also:

• AWS API Documentation

describeStream

default 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()

Parameters:

describeStreamRequest - A Consumer that will call methods on DescribeStreamRequest.Builder to create a request.

Returns:

Result of the DescribeStream operation returned by the service.

See Also:

• AWS API Documentation

getDataEndpoint

default 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.

Parameters:

getDataEndpointRequest -

Returns:

Result of the GetDataEndpoint operation returned by the service.

See Also:

• AWS API Documentation

getDataEndpoint

default 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()

Parameters:

getDataEndpointRequest - A Consumer that will call methods on GetDataEndpointRequest.Builder to create a request.

Returns:

Result of the GetDataEndpoint operation returned by the service.

See Also:

• AWS API Documentation

getSignalingChannelEndpoint

default 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.

Parameters:

getSignalingChannelEndpointRequest -

Returns:

Result of the GetSignalingChannelEndpoint operation returned by the service.

See Also:

• AWS API Documentation

getSignalingChannelEndpoint

default 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()

Parameters:

getSignalingChannelEndpointRequest - A Consumer that will call methods on GetSignalingChannelEndpointRequest.Builder to create a request.

Returns:

Result of the GetSignalingChannelEndpoint operation returned by the service.

See Also:

• AWS API Documentation

listEdgeAgentConfigurations

default ListEdgeAgentConfigurationsResponse listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)
                                                                 throws NotAuthorizedException,
ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

Parameters:

listEdgeAgentConfigurationsRequest -

Returns:

Result of the ListEdgeAgentConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listEdgeAgentConfigurations

default ListEdgeAgentConfigurationsResponse listEdgeAgentConfigurations(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)
                                                                 throws NotAuthorizedException,
ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

This is a convenience which creates an instance of the ListEdgeAgentConfigurationsRequest.Builder avoiding the need to create one manually via ListEdgeAgentConfigurationsRequest.builder()

Parameters:

listEdgeAgentConfigurationsRequest - A Consumer that will call methods on ListEdgeAgentConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListEdgeAgentConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listEdgeAgentConfigurationsPaginator

default ListEdgeAgentConfigurationsIterable listEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)
                                                                          throws NotAuthorizedException,
ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

This is a variant of listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) 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.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client
             .listEdgeAgentConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(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 listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) operation.

Parameters:

listEdgeAgentConfigurationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEdgeAgentConfigurationsPaginator

default ListEdgeAgentConfigurationsIterable listEdgeAgentConfigurationsPaginator(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)
                                                                          throws NotAuthorizedException,
ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

This is a variant of listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) 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.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client
             .listEdgeAgentConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(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 listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest) operation.

This is a convenience which creates an instance of the ListEdgeAgentConfigurationsRequest.Builder avoiding the need to create one manually via ListEdgeAgentConfigurationsRequest.builder()

Parameters:

listEdgeAgentConfigurationsRequest - A Consumer that will call methods on ListEdgeAgentConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSignalingChannels

default 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.

Parameters:

listSignalingChannelsRequest -

Returns:

Result of the ListSignalingChannels operation returned by the service.

See Also:

• AWS API Documentation

listSignalingChannels

default 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()

Parameters:

listSignalingChannelsRequest - A Consumer that will call methods on ListSignalingChannelsRequest.Builder to create a request.

Returns:

Result of the ListSignalingChannels operation returned by the service.

See Also:

• AWS API Documentation

listSignalingChannelsPaginator

default ListSignalingChannelsIterable listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest)
                                                              throws InvalidArgumentException,
ClientLimitExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

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.

Parameters:

listSignalingChannelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSignalingChannelsPaginator

default ListSignalingChannelsIterable listSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)
                                                              throws InvalidArgumentException,
ClientLimitExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

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()

Parameters:

listSignalingChannelsRequest - A Consumer that will call methods on ListSignalingChannelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreams

default 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.

Parameters:

listStreamsRequest -

Returns:

Result of the ListStreams operation returned by the service.

See Also:

• AWS API Documentation

listStreams

default 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()

Parameters:

listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.

Returns:

Result of the ListStreams operation returned by the service.

See Also:

• AWS API Documentation

listStreams

default 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.

Returns:

Result of the ListStreams operation returned by the service.

See Also:

• listStreams(ListStreamsRequest)
• AWS API Documentation

listStreamsPaginator

default ListStreamsIterable listStreamsPaginator()
                                          throws ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listStreamsPaginator(ListStreamsRequest)
• AWS API Documentation

listStreamsPaginator

default ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest)
                                          throws ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

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.

Parameters:

listStreamsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamsPaginator

default ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
                                          throws ClientLimitExceededException,
InvalidArgumentException,
AwsServiceException,
SdkClientException,
KinesisVideoException

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()

Parameters:

listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Returns a list of tags associated with the specified signaling channel.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default 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()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForStream

default 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.

Parameters:

listTagsForStreamRequest -

Returns:

Result of the ListTagsForStream operation returned by the service.

See Also:

• AWS API Documentation

listTagsForStream

default 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()

Parameters:

listTagsForStreamRequest - A Consumer that will call methods on ListTagsForStreamRequest.Builder to create a request.

Returns:

Result of the ListTagsForStream operation returned by the service.

See Also:

• AWS API Documentation

startEdgeConfigurationUpdate

default StartEdgeConfigurationUpdateResponse startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)
                                                                   throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
NoDataRetentionException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

Parameters:

startEdgeConfigurationUpdateRequest -

Returns:

Result of the StartEdgeConfigurationUpdate operation returned by the service.

See Also:

• AWS API Documentation

startEdgeConfigurationUpdate

default StartEdgeConfigurationUpdateResponse startEdgeConfigurationUpdate(Consumer<StartEdgeConfigurationUpdateRequest.Builder> startEdgeConfigurationUpdateRequest)
                                                                   throws AccessDeniedException,
ClientLimitExceededException,
InvalidArgumentException,
NoDataRetentionException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
KinesisVideoException

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

This is a convenience which creates an instance of the StartEdgeConfigurationUpdateRequest.Builder avoiding the need to create one manually via StartEdgeConfigurationUpdateRequest.builder()

Parameters:

startEdgeConfigurationUpdateRequest - A Consumer that will call methods on StartEdgeConfigurationUpdateRequest.Builder to create a request.

Returns:

Result of the StartEdgeConfigurationUpdate operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default 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 Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default 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 Amazon Web Services 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 Billing and Cost Management 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()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagStream

default 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 Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

A Kinesis video stream can support up to 50 tags.

Parameters:

tagStreamRequest -

Returns:

Result of the TagStream operation returned by the service.

See Also:

• AWS API Documentation

tagStream

default 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 Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

A Kinesis video stream can 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()

Parameters:

tagStreamRequest - A Consumer that will call methods on TagStreamRequest.Builder to create a request.

Returns:

Result of the TagStream operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default 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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default 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()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagStream

default 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.

Parameters:

untagStreamRequest -

Returns:

Result of the UntagStream operation returned by the service.

See Also:

• AWS API Documentation

untagStream

default 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()

Parameters:

untagStreamRequest - A Consumer that will call methods on UntagStreamRequest.Builder to create a request.

Returns:

Result of the UntagStream operation returned by the service.

See Also:

• AWS API Documentation

updateDataRetention

default 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.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

• If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

• If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

Parameters:

updateDataRetentionRequest -

Returns:

Result of the UpdateDataRetention operation returned by the service.

See Also:

• AWS API Documentation

updateDataRetention

default 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.

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()

Parameters:

updateDataRetentionRequest - A Consumer that will call methods on UpdateDataRetentionRequest.Builder to create a request.

Returns:

Result of the UpdateDataRetention operation returned by the service.

See Also:

• AWS API Documentation

updateImageGenerationConfiguration

default UpdateImageGenerationConfigurationResponse updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)
                                                                               throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ResourceInUseException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Updates the StreamInfo and ImageProcessingConfiguration fields.

Parameters:

updateImageGenerationConfigurationRequest -

Returns:

Result of the UpdateImageGenerationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateImageGenerationConfiguration

default UpdateImageGenerationConfigurationResponse updateImageGenerationConfiguration(Consumer<UpdateImageGenerationConfigurationRequest.Builder> updateImageGenerationConfigurationRequest)
                                                                               throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ResourceInUseException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Updates the StreamInfo and ImageProcessingConfiguration fields.

This is a convenience which creates an instance of the UpdateImageGenerationConfigurationRequest.Builder avoiding the need to create one manually via UpdateImageGenerationConfigurationRequest.builder()

Parameters:

updateImageGenerationConfigurationRequest - A Consumer that will call methods on UpdateImageGenerationConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateImageGenerationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateMediaStorageConfiguration

default UpdateMediaStorageConfigurationResponse updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)
                                                                         throws ResourceInUseException,
InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify :

• If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled.

• If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

Parameters:

updateMediaStorageConfigurationRequest -

Returns:

Result of the UpdateMediaStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateMediaStorageConfiguration

default UpdateMediaStorageConfigurationResponse updateMediaStorageConfiguration(Consumer<UpdateMediaStorageConfigurationRequest.Builder> updateMediaStorageConfigurationRequest)
                                                                         throws ResourceInUseException,
InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify :

• If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled.

• If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

This is a convenience which creates an instance of the UpdateMediaStorageConfigurationRequest.Builder avoiding the need to create one manually via UpdateMediaStorageConfigurationRequest.builder()

Parameters:

updateMediaStorageConfigurationRequest - A Consumer that will call methods on UpdateMediaStorageConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateMediaStorageConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateNotificationConfiguration

default UpdateNotificationConfigurationResponse updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)
                                                                         throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ResourceInUseException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Updates the notification information for a stream.

Parameters:

updateNotificationConfigurationRequest -

Returns:

Result of the UpdateNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateNotificationConfiguration

default UpdateNotificationConfigurationResponse updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest)
                                                                         throws InvalidArgumentException,
ClientLimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ResourceInUseException,
NoDataRetentionException,
AwsServiceException,
SdkClientException,
KinesisVideoException

Updates the notification information for a stream.

This is a convenience which creates an instance of the UpdateNotificationConfigurationRequest.Builder avoiding the need to create one manually via UpdateNotificationConfigurationRequest.builder()

Parameters:

updateNotificationConfigurationRequest - A Consumer that will call methods on UpdateNotificationConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateSignalingChannel

default 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.

Parameters:

updateSignalingChannelRequest -

Returns:

Result of the UpdateSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

updateSignalingChannel

default 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()

Parameters:

updateSignalingChannelRequest - A Consumer that will call methods on UpdateSignalingChannelRequest.Builder to create a request.

Returns:

Result of the UpdateSignalingChannel operation returned by the service.

See Also:

• AWS API Documentation

updateStream

default 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.

Parameters:

updateStreamRequest -

Returns:

Result of the UpdateStream operation returned by the service.

See Also:

• AWS API Documentation

updateStream

default 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()

Parameters:

updateStreamRequest - A Consumer that will call methods on UpdateStreamRequest.Builder to create a request.

Returns:

Result of the UpdateStream operation returned by the service.

See Also:

• AWS API Documentation

create

static KinesisVideoClient create()

Create a KinesisVideoClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KinesisVideoClientBuilder builder()

Create a builder that can be used to configure and create a KinesisVideoClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KinesisVideoServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration