@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonKinesisVideoAsyncClient extends AmazonKinesisVideoClient implements AmazonKinesisVideoAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
configFactoryclient, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXbuilder, createStream, deleteStream, describeStream, getCachedResponseMetadata, getDataEndpoint, listStreams, listTagsForStream, tagStream, untagStream, updateDataRetention, updateStreamaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateStream, deleteStream, describeStream, getCachedResponseMetadata, getDataEndpoint, listStreams, listTagsForStream, tagStream, untagStream, updateDataRetention, updateStreampublic static AmazonKinesisVideoAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateStreamResult> createStreamAsync(CreateStreamRequest request)
AmazonKinesisVideoAsyncCreates 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.
createStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<CreateStreamResult> createStreamAsync(CreateStreamRequest request, AsyncHandler<CreateStreamRequest,CreateStreamResult> asyncHandler)
AmazonKinesisVideoAsyncCreates 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.
createStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest request)
AmazonKinesisVideoAsyncDeletes 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.
deleteStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest request, AsyncHandler<DeleteStreamRequest,DeleteStreamResult> asyncHandler)
AmazonKinesisVideoAsyncDeletes 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.
deleteStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest request)
AmazonKinesisVideoAsync
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
describeStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest request, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
AmazonKinesisVideoAsync
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
describeStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDataEndpointResult> getDataEndpointAsync(GetDataEndpointRequest request)
AmazonKinesisVideoAsync
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.
getDataEndpointAsync in interface AmazonKinesisVideoAsyncpublic Future<GetDataEndpointResult> getDataEndpointAsync(GetDataEndpointRequest request, AsyncHandler<GetDataEndpointRequest,GetDataEndpointResult> asyncHandler)
AmazonKinesisVideoAsync
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.
getDataEndpointAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
AmazonKinesisVideoAsync
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.
listStreamsAsync in interface AmazonKinesisVideoAsyncpublic Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
AmazonKinesisVideoAsync
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.
listStreamsAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForStreamResult> listTagsForStreamAsync(ListTagsForStreamRequest request)
AmazonKinesisVideoAsyncReturns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
listTagsForStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<ListTagsForStreamResult> listTagsForStreamAsync(ListTagsForStreamRequest request, AsyncHandler<ListTagsForStreamRequest,ListTagsForStreamResult> asyncHandler)
AmazonKinesisVideoAsyncReturns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
listTagsForStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagStreamResult> tagStreamAsync(TagStreamRequest request)
AmazonKinesisVideoAsyncAdds 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.
tagStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<TagStreamResult> tagStreamAsync(TagStreamRequest request, AsyncHandler<TagStreamRequest,TagStreamResult> asyncHandler)
AmazonKinesisVideoAsyncAdds 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.
tagStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagStreamResult> untagStreamAsync(UntagStreamRequest request)
AmazonKinesisVideoAsyncRemoves 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.
untagStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<UntagStreamResult> untagStreamAsync(UntagStreamRequest request, AsyncHandler<UntagStreamRequest,UntagStreamResult> asyncHandler)
AmazonKinesisVideoAsyncRemoves 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.
untagStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataRetentionResult> updateDataRetentionAsync(UpdateDataRetentionRequest request)
AmazonKinesisVideoAsync
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.
updateDataRetentionAsync in interface AmazonKinesisVideoAsyncpublic Future<UpdateDataRetentionResult> updateDataRetentionAsync(UpdateDataRetentionRequest request, AsyncHandler<UpdateDataRetentionRequest,UpdateDataRetentionResult> asyncHandler)
AmazonKinesisVideoAsync
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.
updateDataRetentionAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStreamResult> updateStreamAsync(UpdateStreamRequest request)
AmazonKinesisVideoAsyncUpdates 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.
updateStreamAsync in interface AmazonKinesisVideoAsyncpublic Future<UpdateStreamResult> updateStreamAsync(UpdateStreamRequest request, AsyncHandler<UpdateStreamRequest,UpdateStreamResult> asyncHandler)
AmazonKinesisVideoAsyncUpdates 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.
updateStreamAsync in interface AmazonKinesisVideoAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonKinesisVideoshutdown in class AmazonWebServiceClientCopyright © 2018. All rights reserved.