KinesisVideoAsyncClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
public interface KinesisVideoAsyncClient
extends SdkClient, SdkAutoCloseable
```
Service client for accessing Kinesis Video asynchronously. This can be created using the static builder() method.

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static KinesisVideoAsyncClientBuilder`	`builder()` Create a builder that can be used to configure and create a `KinesisVideoAsyncClient`.
`static KinesisVideoAsyncClient`	`create()` Create a `KinesisVideoAsyncClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CompletableFuture<CreateStreamResponse>`	`createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)` Creates a new Kinesis video stream.
`default CompletableFuture<CreateStreamResponse>`	`createStream(CreateStreamRequest createStreamRequest)` Creates a new Kinesis video stream.
`default CompletableFuture<DeleteStreamResponse>`	`deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)` Deletes a Kinesis video stream and the data contained in the stream.
`default CompletableFuture<DeleteStreamResponse>`	`deleteStream(DeleteStreamRequest deleteStreamRequest)` Deletes a Kinesis video stream and the data contained in the stream.
`default CompletableFuture<DescribeStreamResponse>`	`describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)` Returns the most current information about the specified stream.
`default CompletableFuture<DescribeStreamResponse>`	`describeStream(DescribeStreamRequest describeStreamRequest)` Returns the most current information about the specified stream.
`default CompletableFuture<GetDataEndpointResponse>`	`getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest)` Gets an endpoint for a specified stream for either reading or writing.
`default CompletableFuture<GetDataEndpointResponse>`	`getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)` Gets an endpoint for a specified stream for either reading or writing.
`default CompletableFuture<ListStreamsResponse>`	`listStreams()` Returns an array of `StreamInfo` objects.
`default CompletableFuture<ListStreamsResponse>`	`listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)` Returns an array of `StreamInfo` objects.
`default CompletableFuture<ListStreamsResponse>`	`listStreams(ListStreamsRequest listStreamsRequest)` Returns an array of `StreamInfo` objects.
`default CompletableFuture<ListTagsForStreamResponse>`	`listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)` Returns a list of tags associated with the specified stream.
`default CompletableFuture<ListTagsForStreamResponse>`	`listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)` Returns a list of tags associated with the specified stream.
`default CompletableFuture<TagStreamResponse>`	`tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest)` Adds one or more tags to a stream.
`default CompletableFuture<TagStreamResponse>`	`tagStream(TagStreamRequest tagStreamRequest)` Adds one or more tags to a stream.
`default CompletableFuture<UntagStreamResponse>`	`untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest)` Removes one or more tags from a stream.
`default CompletableFuture<UntagStreamResponse>`	`untagStream(UntagStreamRequest untagStreamRequest)` Removes one or more tags from a stream.
`default CompletableFuture<UpdateDataRetentionResponse>`	`updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest)` Increases or decreases the stream's data retention period by the value that you specify.
`default CompletableFuture<UpdateDataRetentionResponse>`	`updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)` Increases or decreases the stream's data retention period by the value that you specify.
`default CompletableFuture<UpdateStreamResponse>`	`updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)` Updates stream metadata, such as the device name and media type.
`default CompletableFuture<UpdateStreamResponse>`	`updateStream(UpdateStreamRequest updateStreamRequest)` Updates stream metadata, such as the device name and media type.

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

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

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
static KinesisVideoAsyncClient create()
```
    Create a KinesisVideoAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static KinesisVideoAsyncClientBuilder builder()
```
    Create a builder that can be used to configure and create a KinesisVideoAsyncClient.
  - createStream
```
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.
    Parameters:
    
    createStreamRequest -
    
    Returns:
    A Java Future containing the result of the CreateStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    AccountStreamLimitExceededException The number of streams created for the account is too high.
    
    DeviceStreamLimitExceededException Not implemented.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    InvalidDeviceException Not implemented.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - createStream
```
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()
    Parameters:
    
    createStreamRequest - A Consumer that will call methods on CreateStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the CreateStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    AccountStreamLimitExceededException The number of streams created for the account is too high.
    
    DeviceStreamLimitExceededException Not implemented.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    InvalidDeviceException Not implemented.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - deleteStream
```
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.
    Parameters:
    
    deleteStreamRequest -
    
    Returns:
    A Java Future containing the result of the DeleteStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - deleteStream
```
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()
    Parameters:
    
    deleteStreamRequest - A Consumer that will call methods on DeleteStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the DeleteStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - describeStream
```
default CompletableFuture<DescribeStreamResponse> describeStream(DescribeStreamRequest describeStreamRequest)
```
    Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.
    Parameters:
    
    describeStreamRequest -
    
    Returns:
    A Java Future containing the result of the DescribeStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - describeStream
```
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()
    Parameters:
    
    describeStreamRequest - A Consumer that will call methods on DescribeStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the DescribeStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - getDataEndpoint
```
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.
    Parameters:
    
    getDataEndpointRequest -
    
    Returns:
    A Java Future containing the result of the GetDataEndpoint operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - getDataEndpoint
```
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()
    Parameters:
    
    getDataEndpointRequest - A Consumer that will call methods on GetDataEndpointInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the GetDataEndpoint operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listStreams
```
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.
    Parameters:
    
    listStreamsRequest -
    
    Returns:
    A Java Future containing the result of the ListStreams operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listStreams
```
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()
    Parameters:
    
    listStreamsRequest - A Consumer that will call methods on ListStreamsInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the ListStreams operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listStreams
```
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.
    Returns:
    A Java Future containing the result of the ListStreams operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listTagsForStream
```
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.
    Parameters:
    
    listTagsForStreamRequest -
    
    Returns:
    A Java Future containing the result of the ListTagsForStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listTagsForStream
```
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()
    Parameters:
    
    listTagsForStreamRequest - A Consumer that will call methods on ListTagsForStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the ListTagsForStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - tagStream
```
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 AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
    
    You must provide either the StreamName or the StreamARN.
    
    This operation requires permission for the KinesisVideo:TagStream action.
    
    Kinesis video streams support up to 50 tags.
    Parameters:
    
    tagStreamRequest -
    
    Returns:
    A Java Future containing the result of the TagStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - tagStream
```
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 AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
    
    You must provide either the StreamName or the StreamARN.
    
    This operation requires permission for the KinesisVideo:TagStream action.
    
    Kinesis video streams support up to 50 tags.
    
    This is a convenience which creates an instance of the TagStreamRequest.Builder avoiding the need to create one manually via TagStreamRequest.builder()
    Parameters:
    
    tagStreamRequest - A Consumer that will call methods on TagStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the TagStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - untagStream
```
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.
    Parameters:
    
    untagStreamRequest -
    
    Returns:
    A Java Future containing the result of the UntagStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - untagStream
```
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()
    Parameters:
    
    untagStreamRequest - A Consumer that will call methods on UntagStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the UntagStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException The format of the StreamARN is invalid.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - updateDataRetention
```
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.
    Parameters:
    
    updateDataRetentionRequest -
    
    Returns:
    A Java Future containing the result of the UpdateDataRetention operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - updateDataRetention
```
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()
    Parameters:
    
    updateDataRetentionRequest - A Consumer that will call methods on UpdateDataRetentionInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the UpdateDataRetention operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - updateStream
```
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.
    Parameters:
    
    updateStreamRequest -
    
    Returns:
    A Java Future containing the result of the UpdateStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - updateStream
```
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()
    Parameters:
    
    updateStreamRequest - A Consumer that will call methods on UpdateStreamInput.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the UpdateStream operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException The value for this input parameter is invalid.
    
    ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ResourceInUseException The stream is currently not available for this operation.
    
    NotAuthorizedException The caller is not authorized to perform this operation.
    
    VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation

Interface KinesisVideoAsyncClient

Field Summary

Method Summary

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

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

Field Detail

SERVICE_NAME

Method Detail

create

builder

createStream

createStream

deleteStream

deleteStream

describeStream

describeStream

getDataEndpoint

getDataEndpoint

listStreams

listStreams

listStreams

listTagsForStream

listTagsForStream

tagStream

tagStream

untagStream

untagStream

updateDataRetention

updateDataRetention

updateStream

updateStream