software.amazon.awssdk.services.kinesisvideoarchivedmedia

Interface KinesisVideoArchivedMediaClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static KinesisVideoArchivedMediaClientBuilder	builder() Create a builder that can be used to configure and create a KinesisVideoArchivedMediaClient.
static KinesisVideoArchivedMediaClient	create() Create a KinesisVideoArchivedMediaClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetHlsStreamingSessionUrlResponse	getHLSStreamingSessionURL(Consumer<GetHlsStreamingSessionUrlRequest.Builder> getHlsStreamingSessionUrlRequest) Retrieves an HTTP Live Streaming (HLS) URL for the stream.
default GetHlsStreamingSessionUrlResponse	getHLSStreamingSessionURL(GetHlsStreamingSessionUrlRequest getHlsStreamingSessionUrlRequest) Retrieves an HTTP Live Streaming (HLS) URL for the stream.
default ResponseInputStream<GetMediaForFragmentListResponse>	getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default GetMediaForFragmentListResponse	getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest, Path filePath) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default <ReturnT> ReturnT	getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest, ResponseTransformer<GetMediaForFragmentListResponse,ReturnT> responseTransformer) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default ResponseInputStream<GetMediaForFragmentListResponse>	getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default GetMediaForFragmentListResponse	getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest, Path filePath) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default <ReturnT> ReturnT	getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest, ResponseTransformer<GetMediaForFragmentListResponse,ReturnT> responseTransformer) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default ResponseBytes<GetMediaForFragmentListResponse>	getMediaForFragmentListAsBytes(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default ResponseBytes<GetMediaForFragmentListResponse>	getMediaForFragmentListAsBytes(GetMediaForFragmentListRequest getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
default ListFragmentsResponse	listFragments(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest) Returns a list of Fragment objects from the specified stream and start location within the archived data.
default ListFragmentsResponse	listFragments(ListFragmentsRequest listFragmentsRequest) Returns a list of Fragment objects from the specified stream and start location within the archived data.
static ServiceMetadata	serviceMetadata()

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 KinesisVideoArchivedMediaClient create()

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

builder

static KinesisVideoArchivedMediaClientBuilder builder()

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

getHLSStreamingSessionURL

default GetHlsStreamingSessionUrlResponse getHLSStreamingSessionURL(GetHlsStreamingSessionUrlRequest getHlsStreamingSessionUrlRequest)
                                                             throws ResourceNotFoundException,
                                                                    InvalidArgumentException,
                                                                    ClientLimitExceededException,
                                                                    NotAuthorizedException,
                                                                    UnsupportedStreamMediaTypeException,
                                                                    NoDataRetentionException,
                                                                    MissingCodecPrivateDataException,
                                                                    InvalidCodecPrivateDataException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KinesisVideoArchivedMediaException

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

• The media type must be video/h264.

• Data retention must be greater than 0.

• The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

The following procedure shows how to use HLS with Kinesis Video Streams:

1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

   Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

   The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bit rates) is made available.

3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

   • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

   • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE.

   • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and " moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

     The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream, which the media player needs to decode video frames.

   • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and " mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

     After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

     Data retrieved with this action is billable. See Pricing for details.

The following restrictions apply to HLS sessions:

• A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

• A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

Parameters:

getHlsStreamingSessionUrlRequest -

Returns:

Result of the GetHLSStreamingSessionURL operation returned by the service.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

UnsupportedStreamMediaTypeException - An HLS streaming session was requested for a stream with a media type that is not video/h264 .

NoDataRetentionException - A PlaybackMode of ON_DEMAND was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

MissingCodecPrivateDataException - No Codec Private Data was found in the video stream.

InvalidCodecPrivateDataException - The Codec Private Data in the video stream is not valid for 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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getHLSStreamingSessionURL

default GetHlsStreamingSessionUrlResponse getHLSStreamingSessionURL(Consumer<GetHlsStreamingSessionUrlRequest.Builder> getHlsStreamingSessionUrlRequest)
                                                             throws ResourceNotFoundException,
                                                                    InvalidArgumentException,
                                                                    ClientLimitExceededException,
                                                                    NotAuthorizedException,
                                                                    UnsupportedStreamMediaTypeException,
                                                                    NoDataRetentionException,
                                                                    MissingCodecPrivateDataException,
                                                                    InvalidCodecPrivateDataException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KinesisVideoArchivedMediaException

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

• The media type must be video/h264.

• Data retention must be greater than 0.

• The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

The following procedure shows how to use HLS with Kinesis Video Streams:

1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

   Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

   The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bit rates) is made available.

3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

   • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

   • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE.

   • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and " moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

     The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream, which the media player needs to decode video frames.

   • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and " mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

     After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

     Data retrieved with this action is billable. See Pricing for details.

The following restrictions apply to HLS sessions:

• A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

• A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

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

Parameters:

getHlsStreamingSessionUrlRequest - A Consumer that will call methods on GetHLSStreamingSessionURLInput.Builder to create a request.

Returns:

Result of the GetHLSStreamingSessionURL operation returned by the service.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

UnsupportedStreamMediaTypeException - An HLS streaming session was requested for a stream with a media type that is not video/h264 .

NoDataRetentionException - A PlaybackMode of ON_DEMAND was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

MissingCodecPrivateDataException - No Codec Private Data was found in the video stream.

InvalidCodecPrivateDataException - The Codec Private Data in the video stream is not valid for 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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMediaForFragmentList

default <ReturnT> ReturnT getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest,
                                                  ResponseTransformer<GetMediaForFragmentListResponse,ReturnT> responseTransformer)
                                           throws ResourceNotFoundException,
                                                  InvalidArgumentException,
                                                  ClientLimitExceededException,
                                                  NotAuthorizedException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

Parameters:

getMediaForFragmentListRequest -

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetMediaForFragmentListResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMediaForFragmentList

default <ReturnT> ReturnT getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest,
                                                  ResponseTransformer<GetMediaForFragmentListResponse,ReturnT> responseTransformer)
                                           throws ResourceNotFoundException,
                                                  InvalidArgumentException,
                                                  ClientLimitExceededException,
                                                  NotAuthorizedException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

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

Parameters:

getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.Builder to create a request.

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetMediaForFragmentListResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMediaForFragmentList

default GetMediaForFragmentListResponse getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest,
                                                                Path filePath)
                                                         throws ResourceNotFoundException,
                                                                InvalidArgumentException,
                                                                ClientLimitExceededException,
                                                                NotAuthorizedException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

Parameters:

getMediaForFragmentListRequest -

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 that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

getMediaForFragmentList(GetMediaForFragmentListRequest, ResponseTransformer), AWS API Documentation

getMediaForFragmentList

default GetMediaForFragmentListResponse getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest,
                                                                Path filePath)
                                                         throws ResourceNotFoundException,
                                                                InvalidArgumentException,
                                                                ClientLimitExceededException,
                                                                NotAuthorizedException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

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

Parameters:

getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.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 that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

getMediaForFragmentList(GetMediaForFragmentListRequest, ResponseTransformer), AWS API Documentation

getMediaForFragmentList

default ResponseInputStream<GetMediaForFragmentListResponse> getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest)
                                                                              throws ResourceNotFoundException,
                                                                                     InvalidArgumentException,
                                                                                     ClientLimitExceededException,
                                                                                     NotAuthorizedException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

Parameters:

getMediaForFragmentListRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

#getObject(getMediaForFragmentList, ResponseTransformer), AWS API Documentation

getMediaForFragmentList

default ResponseInputStream<GetMediaForFragmentListResponse> getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest)
                                                                              throws ResourceNotFoundException,
                                                                                     InvalidArgumentException,
                                                                                     ClientLimitExceededException,
                                                                                     NotAuthorizedException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

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

Parameters:

getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

#getObject(getMediaForFragmentList, ResponseTransformer), AWS API Documentation

getMediaForFragmentListAsBytes

default ResponseBytes<GetMediaForFragmentListResponse> getMediaForFragmentListAsBytes(GetMediaForFragmentListRequest getMediaForFragmentListRequest)
                                                                               throws ResourceNotFoundException,
                                                                                      InvalidArgumentException,
                                                                                      ClientLimitExceededException,
                                                                                      NotAuthorizedException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

Parameters:

getMediaForFragmentListRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

#getObject(getMediaForFragmentList, ResponseTransformer), AWS API Documentation

getMediaForFragmentListAsBytes

default ResponseBytes<GetMediaForFragmentListResponse> getMediaForFragmentListAsBytes(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest)
                                                                               throws ResourceNotFoundException,
                                                                                      InvalidArgumentException,
                                                                                      ClientLimitExceededException,
                                                                                      NotAuthorizedException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      KinesisVideoArchivedMediaException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

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

Parameters:

getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

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

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

'.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

#getObject(getMediaForFragmentList, ResponseTransformer), AWS API Documentation

listFragments

default ListFragmentsResponse listFragments(ListFragmentsRequest listFragmentsRequest)
                                     throws ResourceNotFoundException,
                                            InvalidArgumentException,
                                            ClientLimitExceededException,
                                            NotAuthorizedException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KinesisVideoArchivedMediaException

Returns a list of Fragment objects from the specified stream and start location within the archived data.

Parameters:

listFragmentsRequest -

Returns:

Result of the ListFragments operation returned by the service.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listFragments

default ListFragmentsResponse listFragments(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest)
                                     throws ResourceNotFoundException,
                                            InvalidArgumentException,
                                            ClientLimitExceededException,
                                            NotAuthorizedException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KinesisVideoArchivedMediaException

Returns a list of Fragment objects from the specified stream and start location within the archived data.

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

Parameters:

listFragmentsRequest - A Consumer that will call methods on ListFragmentsInput.Builder to create a request.

Returns:

Result of the ListFragments operation returned by the service.

Throws:

ResourceNotFoundException - GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL throws this error if a session with a PlaybackMode of ON_DEMAND is requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.

KinesisVideoArchivedMediaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()