[ aws . kinesis-video-archived-media ]

get-media-for-fragment-list

Description

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

Note

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

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.

Warning

If an error is thrown after invoking a Kinesis Video Streams archived 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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-media-for-fragment-list
--stream-name <value>
--fragments <value>
<outfile>

Options

--stream-name (string)

The name of the stream from which to retrieve fragment media.

--fragments (list)

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments .

(string)

Syntax:

"string" "string" ...

outfile (string) Filename where the content will be saved

See ‘aws help’ for descriptions of global parameters.

Output

ContentType -> (string)

The content type of the requested media.

Payload -> (blob)

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 timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp 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