@Generated(value="software.amazon.awssdk:codegen") public interface KinesisVideoAsyncClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
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.
|
serviceName
close
static final String SERVICE_NAME
static KinesisVideoAsyncClient create()
KinesisVideoAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static KinesisVideoAsyncClientBuilder builder()
KinesisVideoAsyncClient
.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
- 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 CreateStreamInput.Builder
to create a request.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
- 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 DeleteStreamInput.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 DescribeStreamInput.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 GetDataEndpointInput.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 ListStreamsInput.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 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 ListTagsForStreamInput.Builder
to create a request.StreamARN
is invalid.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.
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 AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
You must provide either the StreamName
or the StreamARN
.
This operation requires permission for the KinesisVideo:TagStream
action.
Kinesis video streams support up to 50 tags.
This is a convenience which creates an instance of the TagStreamRequest.Builder
avoiding the need to
create one manually via TagStreamRequest.builder()
tagStreamRequest
- A Consumer
that will call methods on TagStreamInput.Builder
to create a request.StreamARN
is invalid.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 UntagStreamInput.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
- 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 UpdateDataRetentionInput.Builder
to create a request.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
- 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 UpdateStreamInput.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.