software.amazon.awssdk.services.kinesisvideomedia

Interface KinesisVideoMediaAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface KinesisVideoMediaAsyncClient
extends SdkClient

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static KinesisVideoMediaAsyncClientBuilder	builder() Create a builder that can be used to configure and create a KinesisVideoMediaAsyncClient.
static KinesisVideoMediaAsyncClient	create() Create a KinesisVideoMediaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default <ReturnT> CompletableFuture<ReturnT>	getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest, AsyncResponseTransformer<GetMediaResponse,ReturnT> asyncResponseTransformer) Use this API to retrieve media content from a Kinesis video stream.
default CompletableFuture<GetMediaResponse>	getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest, Path destinationPath) Use this API to retrieve media content from a Kinesis video stream.
default <ReturnT> CompletableFuture<ReturnT>	getMedia(GetMediaRequest getMediaRequest, AsyncResponseTransformer<GetMediaResponse,ReturnT> asyncResponseTransformer) Use this API to retrieve media content from a Kinesis video stream.
default CompletableFuture<GetMediaResponse>	getMedia(GetMediaRequest getMediaRequest, Path destinationPath) Use this API to retrieve media content from a Kinesis video stream.

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

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

Constant Field Values

Method Detail

create

static KinesisVideoMediaAsyncClient create()

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

builder

static KinesisVideoMediaAsyncClientBuilder builder()

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

getMedia

default <ReturnT> CompletableFuture<ReturnT> getMedia(GetMediaRequest getMediaRequest,
                                                      AsyncResponseTransformer<GetMediaResponse,ReturnT> asyncResponseTransformer)

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

• A client can call GetMedia up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

• x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

• x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

Parameters:

getMediaRequest -

asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

• AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

• AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

• AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

• 3002 - Error writing to the stream

• 4000 - Requested fragment is not found

• 4500 - Access denied for the stream's KMS key

• 4501 - Stream's KMS key is disabled

• 4502 - Validation error on the stream's KMS key

• 4503 - KMS key specified in the stream is unavailable

• 4504 - Invalid usage of the KMS key specified in the stream

• 4505 - Invalid state of the KMS key specified in the stream

• 4506 - Unable to find the KMS key specified in the stream

• 5000 - Internal error

'.

Returns:

A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Status Code: 404, The stream with the given name does not exist.
• NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.
• InvalidEndpointException Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call.
• ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
• ConnectionLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.
• 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.
• KinesisVideoMediaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getMedia

default <ReturnT> CompletableFuture<ReturnT> getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest,
                                                      AsyncResponseTransformer<GetMediaResponse,ReturnT> asyncResponseTransformer)

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

• A client can call GetMedia up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

• x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

• x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

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

Parameters:

getMediaRequest - A Consumer that will call methods on GetMediaInput.Builder to create a request.

asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

• AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

• AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

• AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

• 3002 - Error writing to the stream

• 4000 - Requested fragment is not found

• 4500 - Access denied for the stream's KMS key

• 4501 - Stream's KMS key is disabled

• 4502 - Validation error on the stream's KMS key

• 4503 - KMS key specified in the stream is unavailable

• 4504 - Invalid usage of the KMS key specified in the stream

• 4505 - Invalid state of the KMS key specified in the stream

• 4506 - Unable to find the KMS key specified in the stream

• 5000 - Internal error

'.

Returns:

A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Status Code: 404, The stream with the given name does not exist.
• NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.
• InvalidEndpointException Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call.
• ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
• ConnectionLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.
• 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.
• KinesisVideoMediaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getMedia

default CompletableFuture<GetMediaResponse> getMedia(GetMediaRequest getMediaRequest,
                                                     Path destinationPath)

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

• A client can call GetMedia up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

• x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

• x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

Parameters:

getMediaRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

• AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

• AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

• AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

• 3002 - Error writing to the stream

• 4000 - Requested fragment is not found

• 4500 - Access denied for the stream's KMS key

• 4501 - Stream's KMS key is disabled

• 4502 - Validation error on the stream's KMS key

• 4503 - KMS key specified in the stream is unavailable

• 4504 - Invalid usage of the KMS key specified in the stream

• 4505 - Invalid state of the KMS key specified in the stream

• 4506 - Unable to find the KMS key specified in the stream

• 5000 - Internal error

'.

Returns:

A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Status Code: 404, The stream with the given name does not exist.
• NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.
• InvalidEndpointException Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call.
• ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
• ConnectionLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.
• 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.
• KinesisVideoMediaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getMedia

default CompletableFuture<GetMediaResponse> getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest,
                                                     Path destinationPath)

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

• A client can call GetMedia up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

• x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

• x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

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

Parameters:

getMediaRequest - A Consumer that will call methods on GetMediaInput.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

• AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

• AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

• AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

• 3002 - Error writing to the stream

• 4000 - Requested fragment is not found

• 4500 - Access denied for the stream's KMS key

• 4501 - Stream's KMS key is disabled

• 4502 - Validation error on the stream's KMS key

• 4503 - KMS key specified in the stream is unavailable

• 4504 - Invalid usage of the KMS key specified in the stream

• 4505 - Invalid state of the KMS key specified in the stream

• 4506 - Unable to find the KMS key specified in the stream

• 5000 - Internal error

'.

Returns:

A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Status Code: 404, The stream with the given name does not exist.
• NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.
• InvalidEndpointException Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call.
• ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
• ConnectionLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.
• 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.
• KinesisVideoMediaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation