@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KinesisVideoAsyncClient extends AwsClient
builder()
method.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateSignalingChannelResponse> createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
Creates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
createSignalingChannelRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<CreateSignalingChannelResponse> createSignalingChannel(Consumer<CreateSignalingChannelRequest.Builder> createSignalingChannelRequest)
Creates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
This is a convenience which creates an instance of the CreateSignalingChannelRequest.Builder avoiding the
need to create one manually via CreateSignalingChannelRequest.builder()
createSignalingChannelRequest - A Consumer that will call methods on
CreateSignalingChannelRequest.Builder to create
a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<CreateStreamResponse> createStream(CreateStreamRequest createStreamRequest)
Creates a new Kinesis video stream.
When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
CreateStream is an asynchronous operation.
For information about how the service works, see How it Works.
You must have permissions for the KinesisVideo:CreateStream action.
createStreamRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<CreateStreamResponse> createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
Creates a new Kinesis video stream.
When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
CreateStream is an asynchronous operation.
For information about how the service works, see How it Works.
You must have permissions for the KinesisVideo:CreateStream action.
This is a convenience which creates an instance of the CreateStreamRequest.Builder avoiding the need to
create one manually via CreateStreamRequest.builder()
createStreamRequest - A Consumer that will call methods on
CreateStreamRequest.Builder to create a
request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<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.
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.
deleteEdgeConfigurationRequest - default CompletableFuture<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.
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()
deleteEdgeConfigurationRequest - A Consumer that will call methods on
DeleteEdgeConfigurationRequest.Builder to
create a request.default CompletableFuture<DeleteSignalingChannelResponse> deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you
don't specify the channel's current version, the most recent version is deleted.
deleteSignalingChannelRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<DeleteSignalingChannelResponse> deleteSignalingChannel(Consumer<DeleteSignalingChannelRequest.Builder> deleteSignalingChannelRequest)
Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you
don't specify the channel's current version, the most recent version is deleted.
This is a convenience which creates an instance of the DeleteSignalingChannelRequest.Builder avoiding the
need to create one manually via DeleteSignalingChannelRequest.builder()
deleteSignalingChannelRequest - A Consumer that will call methods on
DeleteSignalingChannelRequest.Builder to create
a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<DeleteStreamResponse> deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that you have the latest version of the stream before deleting it, you can specify the stream version.
Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a
new version number. To get the latest stream version, use the DescribeStream API.
This operation requires permission for the KinesisVideo:DeleteStream action.
deleteStreamRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<DeleteStreamResponse> deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that you have the latest version of the stream before deleting it, you can specify the stream version.
Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a
new version number. To get the latest stream version, use the DescribeStream API.
This operation requires permission for the KinesisVideo:DeleteStream action.
This is a convenience which creates an instance of the DeleteStreamRequest.Builder avoiding the need to
create one manually via DeleteStreamRequest.builder()
deleteStreamRequest - A Consumer that will call methods on
DeleteStreamRequest.Builder to create a
request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<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. 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.
describeEdgeConfigurationRequest - default CompletableFuture<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. 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()
describeEdgeConfigurationRequest - A Consumer that will call methods on
DescribeEdgeConfigurationRequest.Builder to
create a request.default CompletableFuture<DescribeImageGenerationConfigurationResponse> describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)
Gets the ImageGenerationConfiguration for a given Kinesis video stream.
describeImageGenerationConfigurationRequest - default CompletableFuture<DescribeImageGenerationConfigurationResponse> describeImageGenerationConfiguration(Consumer<DescribeImageGenerationConfigurationRequest.Builder> describeImageGenerationConfigurationRequest)
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()
describeImageGenerationConfigurationRequest - A Consumer that will call methods on
DescribeImageGenerationConfigurationRequest.Builder
to create a request.default CompletableFuture<DescribeMappedResourceConfigurationResponse> describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)
Returns the most current information about the stream. The streamName or streamARN
should be provided in the input.
describeMappedResourceConfigurationRequest - default CompletableFuture<DescribeMappedResourceConfigurationResponse> describeMappedResourceConfiguration(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)
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()
describeMappedResourceConfigurationRequest - A Consumer that will call methods on
DescribeMappedResourceConfigurationRequest.Builder
to create a request.default DescribeMappedResourceConfigurationPublisher describeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)
Returns the most current information about the stream. The streamName or streamARN
should be provided in the input.
This is a variant of
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
describeMappedResourceConfigurationRequest - default DescribeMappedResourceConfigurationPublisher describeMappedResourceConfigurationPaginator(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)
Returns the most current information about the stream. The streamName or streamARN
should be provided in the input.
This is a variant of
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
describeMappedResourceConfigurationRequest - A Consumer that will call methods on
DescribeMappedResourceConfigurationRequest.Builder
to create a request.default CompletableFuture<DescribeMediaStorageConfigurationResponse> describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)
This API is related to WebRTC
Ingestion and is only available in the us-west-2 region.
Returns the most current information about the channel. Specify the ChannelName or
ChannelARN in the input.
describeMediaStorageConfigurationRequest - default CompletableFuture<DescribeMediaStorageConfigurationResponse> describeMediaStorageConfiguration(Consumer<DescribeMediaStorageConfigurationRequest.Builder> describeMediaStorageConfigurationRequest)
This API is related to WebRTC
Ingestion and is only available in the us-west-2 region.
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()
describeMediaStorageConfigurationRequest - A Consumer that will call methods on
DescribeMediaStorageConfigurationRequest.Builder
to create a request.default CompletableFuture<DescribeNotificationConfigurationResponse> describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)
Gets the NotificationConfiguration for a given Kinesis video stream.
describeNotificationConfigurationRequest - default CompletableFuture<DescribeNotificationConfigurationResponse> describeNotificationConfiguration(Consumer<DescribeNotificationConfigurationRequest.Builder> describeNotificationConfigurationRequest)
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()
describeNotificationConfigurationRequest - A Consumer that will call methods on
DescribeNotificationConfigurationRequest.Builder
to create a request.default CompletableFuture<DescribeSignalingChannelResponse> describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
describeSignalingChannelRequest - default CompletableFuture<DescribeSignalingChannelResponse> describeSignalingChannel(Consumer<DescribeSignalingChannelRequest.Builder> describeSignalingChannelRequest)
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
This is a convenience which creates an instance of the DescribeSignalingChannelRequest.Builder avoiding
the need to create one manually via DescribeSignalingChannelRequest.builder()
describeSignalingChannelRequest - A Consumer that will call methods on
DescribeSignalingChannelRequest.Builder to
create a request.default CompletableFuture<DescribeStreamResponse> describeStream(DescribeStreamRequest describeStreamRequest)
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
describeStreamRequest - default CompletableFuture<DescribeStreamResponse> describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest - A Consumer that will call methods on
DescribeStreamRequest.Builder to create a
request.default CompletableFuture<GetDataEndpointResponse> getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to
read from the specified stream (using the GetMedia or GetMediaForFragmentList
operations) or write to it (using the PutMedia operation).
The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by StreamName or StreamARN.
getDataEndpointRequest - default CompletableFuture<GetDataEndpointResponse> getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to
read from the specified stream (using the GetMedia or GetMediaForFragmentList
operations) or write to it (using the PutMedia operation).
The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by StreamName or StreamARN.
This is a convenience which creates an instance of the GetDataEndpointRequest.Builder avoiding the need
to create one manually via GetDataEndpointRequest.builder()
getDataEndpointRequest - A Consumer that will call methods on
GetDataEndpointRequest.Builder to create a
request.default CompletableFuture<GetSignalingChannelEndpointResponse> getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfiguration input parameter, which consists of the
Protocols and Role properties.
Protocols is used to determine the communication mechanism. For example, if you specify
WSS as the protocol, this API produces a secure websocket endpoint. If you specify
HTTPS as the protocol, this API generates an HTTPS endpoint.
Role determines the messaging permissions. A MASTER role results in this API generating
an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER
role results in this API generating an endpoint that a client can use to communicate only with a
MASTER.
getSignalingChannelEndpointRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<GetSignalingChannelEndpointResponse> getSignalingChannelEndpoint(Consumer<GetSignalingChannelEndpointRequest.Builder> getSignalingChannelEndpointRequest)
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfiguration input parameter, which consists of the
Protocols and Role properties.
Protocols is used to determine the communication mechanism. For example, if you specify
WSS as the protocol, this API produces a secure websocket endpoint. If you specify
HTTPS as the protocol, this API generates an HTTPS endpoint.
Role determines the messaging permissions. A MASTER role results in this API generating
an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER
role results in this API generating an endpoint that a client can use to communicate only with a
MASTER.
This is a convenience which creates an instance of the GetSignalingChannelEndpointRequest.Builder
avoiding the need to create one manually via GetSignalingChannelEndpointRequest.builder()
getSignalingChannelEndpointRequest - A Consumer that will call methods on
GetSignalingChannelEndpointRequest.Builder to
create a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<ListEdgeAgentConfigurationsResponse> listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)
Returns an array of edge configurations associated with the specified Edge Agent.
In the request, you must specify the Edge Agent HubDeviceArn.
listEdgeAgentConfigurationsRequest - default CompletableFuture<ListEdgeAgentConfigurationsResponse> listEdgeAgentConfigurations(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)
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()
listEdgeAgentConfigurationsRequest - A Consumer that will call methods on
ListEdgeAgentConfigurationsRequest.Builder to
create a request.default ListEdgeAgentConfigurationsPublisher listEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)
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 variant of
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listEdgeAgentConfigurationsRequest - default ListEdgeAgentConfigurationsPublisher listEdgeAgentConfigurationsPaginator(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)
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 variant of
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listEdgeAgentConfigurationsRequest - A Consumer that will call methods on
ListEdgeAgentConfigurationsRequest.Builder to
create a request.default CompletableFuture<ListSignalingChannelsResponse> listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
listSignalingChannelsRequest - default CompletableFuture<ListSignalingChannelsResponse> listSignalingChannels(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
This is a convenience which creates an instance of the ListSignalingChannelsRequest.Builder avoiding the
need to create one manually via ListSignalingChannelsRequest.builder()
listSignalingChannelsRequest - A Consumer that will call methods on
ListSignalingChannelsRequest.Builder to create
a request.default ListSignalingChannelsPublisher listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest)
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation.
listSignalingChannelsRequest - default ListSignalingChannelsPublisher listSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)
operation.
This is a convenience which creates an instance of the ListSignalingChannelsRequest.Builder avoiding the
need to create one manually via ListSignalingChannelsRequest.builder()
listSignalingChannelsRequest - A Consumer that will call methods on
ListSignalingChannelsRequest.Builder to create
a request.default CompletableFuture<ListStreamsResponse> listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
listStreamsRequest - default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on
ListStreamsRequest.Builder to create a request.default CompletableFuture<ListStreamsResponse> listStreams()
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.
default ListStreamsPublisher listStreamsPaginator()
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListStreamsPublisher listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
listStreamsRequest - default ListStreamsPublisher listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
This is a variant of listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest) operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on
ListStreamsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags associated with the specified signaling channel.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListTagsForStreamResponse> listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
listTagsForStreamRequest - StreamARN is invalid.default CompletableFuture<ListTagsForStreamResponse> listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
This is a convenience which creates an instance of the ListTagsForStreamRequest.Builder avoiding the need
to create one manually via ListTagsForStreamRequest.builder()
listTagsForStreamRequest - A Consumer that will call methods on
ListTagsForStreamRequest.Builder to create a
request.StreamARN is invalid.default CompletableFuture<StartEdgeConfigurationUpdateResponse> startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)
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.
startEdgeConfigurationUpdateRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<StartEdgeConfigurationUpdateResponse> startEdgeConfigurationUpdate(Consumer<StartEdgeConfigurationUpdateRequest.Builder> startEdgeConfigurationUpdateRequest)
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()
startEdgeConfigurationUpdateRequest - A Consumer that will call methods on
StartEdgeConfigurationUpdateRequest.Builder to
create a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to 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.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to 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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<TagStreamResponse> tagStream(TagStreamRequest tagStreamRequest)
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to 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.
tagStreamRequest - StreamARN is invalid.default CompletableFuture<TagStreamResponse> tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest)
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to 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()
tagStreamRequest - A Consumer that will call methods on
TagStreamRequest.Builder to create a request.StreamARN is invalid.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<UntagStreamResponse> untagStream(UntagStreamRequest untagStreamRequest)
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
In the request, you must provide the StreamName or StreamARN.
untagStreamRequest - StreamARN is invalid.default CompletableFuture<UntagStreamResponse> untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest)
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
In the request, you must provide the StreamName or StreamARN.
This is a convenience which creates an instance of the UntagStreamRequest.Builder avoiding the need to
create one manually via UntagStreamRequest.builder()
untagStreamRequest - A Consumer that will call methods on
UntagStreamRequest.Builder to create a request.StreamARN is invalid.default CompletableFuture<UpdateDataRetentionResponse> updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you
want to increase or decrease the data retention period, specify the Operation parameter in the
request body. In the request, you must specify either the StreamName or the StreamARN.
The retention period that you specify replaces the current value.
This operation requires permission for the KinesisVideo:UpdateDataRetention action.
Changing the data retention period affects the data in the stream as follows:
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
updateDataRetentionRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateDataRetentionResponse> updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you
want to increase or decrease the data retention period, specify the Operation parameter in the
request body. In the request, you must specify either the StreamName or the StreamARN.
The retention period that you specify replaces the current value.
This operation requires permission for the KinesisVideo:UpdateDataRetention action.
Changing the data retention period affects the data in the stream as follows:
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
This is a convenience which creates an instance of the UpdateDataRetentionRequest.Builder avoiding the
need to create one manually via UpdateDataRetentionRequest.builder()
updateDataRetentionRequest - A Consumer that will call methods on
UpdateDataRetentionRequest.Builder to create a
request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateImageGenerationConfigurationResponse> updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)
Updates the StreamInfo and ImageProcessingConfiguration fields.
updateImageGenerationConfigurationRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateImageGenerationConfigurationResponse> updateImageGenerationConfiguration(Consumer<UpdateImageGenerationConfigurationRequest.Builder> updateImageGenerationConfigurationRequest)
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()
updateImageGenerationConfigurationRequest - A Consumer that will call methods on
UpdateImageGenerationConfigurationRequest.Builder
to create a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateMediaStorageConfigurationResponse> updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)
This API is related to WebRTC
Ingestion and is only available in the us-west-2 region.
Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can
specified :
If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter
will not be needed.
If the StorageStatus is enabled, the data will be stored in the StreamARN provided.
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.
updateMediaStorageConfigurationRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateMediaStorageConfigurationResponse> updateMediaStorageConfiguration(Consumer<UpdateMediaStorageConfigurationRequest.Builder> updateMediaStorageConfigurationRequest)
This API is related to WebRTC
Ingestion and is only available in the us-west-2 region.
Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can
specified :
If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter
will not be needed.
If the StorageStatus is enabled, the data will be stored in the StreamARN provided.
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()
updateMediaStorageConfigurationRequest - A Consumer that will call methods on
UpdateMediaStorageConfigurationRequest.Builder
to create a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateNotificationConfigurationResponse> updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)
Updates the notification information for a stream.
updateNotificationConfigurationRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateNotificationConfigurationResponse> updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest)
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()
updateNotificationConfigurationRequest - A Consumer that will call methods on
UpdateNotificationConfigurationRequest.Builder
to create a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateSignalingChannelResponse> updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new
messages sent via this channel after it's been updated. Existing messages are still expired as per the previous
MessageTtlSeconds value.
updateSignalingChannelRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateSignalingChannelResponse> updateSignalingChannel(Consumer<UpdateSignalingChannelRequest.Builder> updateSignalingChannelRequest)
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new
messages sent via this channel after it's been updated. Existing messages are still expired as per the previous
MessageTtlSeconds value.
This is a convenience which creates an instance of the UpdateSignalingChannelRequest.Builder avoiding the
need to create one manually via UpdateSignalingChannelRequest.builder()
updateSignalingChannelRequest - A Consumer that will call methods on
UpdateSignalingChannelRequest.Builder to create
a request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateStreamResponse> updateStream(UpdateStreamRequest updateStreamRequest)
Updates stream metadata, such as the device name and media type.
You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
To make sure that you have the latest version of the stream before updating it, you can specify the stream
version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams
assigns a new version number. To get the latest stream version, use the DescribeStream API.
UpdateStream is an asynchronous operation, and takes time to complete.
updateStreamRequest - StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default CompletableFuture<UpdateStreamResponse> updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)
Updates stream metadata, such as the device name and media type.
You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
To make sure that you have the latest version of the stream before updating it, you can specify the stream
version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams
assigns a new version number. To get the latest stream version, use the DescribeStream API.
UpdateStream is an asynchronous operation, and takes time to complete.
This is a convenience which creates an instance of the UpdateStreamRequest.Builder avoiding the need to
create one manually via UpdateStreamRequest.builder()
updateStreamRequest - A Consumer that will call methods on
UpdateStreamRequest.Builder to create a
request.StreamARN or ChannelARN in
CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
provided input StreamARN or ChannelARN is not in Active status, try one of the
following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
default KinesisVideoServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic KinesisVideoAsyncClient create()
KinesisVideoAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KinesisVideoAsyncClientBuilder builder()
KinesisVideoAsyncClient.Copyright © 2023. All rights reserved.