Amazon Kinesis Video Streams Archived Media

{'StreamARN': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.get_media_for_fragment_list(
    StreamName='string',
    StreamARN='string',
    Fragments=[
        'string',
    ]
)

type StreamName:

string

param StreamName:

The name of the stream from which to retrieve fragment media. Specify either this parameter or the StreamARN parameter.

type StreamARN:

string

param StreamARN:

The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the StreamName parameter.

type Fragments:

list

param Fragments:

[REQUIRED]

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

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'ContentType': 'string',
    'Payload': StreamingBody()
}

Response Structure

• (dict) --

  • ContentType (string) --

    The content type of the requested media.

  • Payload (:class:`.StreamingBody`) --

    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

{'StreamARN': 'string'}

Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

See also: AWS API Documentation

Request Syntax

client.list_fragments(
    StreamName='string',
    StreamARN='string',
    MaxResults=123,
    NextToken='string',
    FragmentSelector={
        'FragmentSelectorType': 'PRODUCER_TIMESTAMP'|'SERVER_TIMESTAMP',
        'TimestampRange': {
            'StartTimestamp': datetime(2015, 1, 1),
            'EndTimestamp': datetime(2015, 1, 1)
        }
    }
)

type StreamName:

string

param StreamName:

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

type StreamARN:

string

param StreamARN:

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

type MaxResults:

integer

param MaxResults:

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

type NextToken:

string

param NextToken:

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

type FragmentSelector:

dict

param FragmentSelector:

Describes the timestamp range and timestamp origin for the range of fragments to return.

• FragmentSelectorType (string) -- [REQUIRED]

  The origin of the timestamps to use (Server or Producer).

• TimestampRange (dict) -- [REQUIRED]

  The range of timestamps to return.

  • StartTimestamp (datetime) -- [REQUIRED]

    The starting timestamp in the range of timestamps for which to return fragments.

  • EndTimestamp (datetime) -- [REQUIRED]

    The ending timestamp in the range of timestamps for which to return fragments.

rtype:

dict

returns:

Response Syntax

{
    'Fragments': [
        {
            'FragmentNumber': 'string',
            'FragmentSizeInBytes': 123,
            'ProducerTimestamp': datetime(2015, 1, 1),
            'ServerTimestamp': datetime(2015, 1, 1),
            'FragmentLengthInMilliseconds': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Fragments (list) --

    A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.

    • (dict) --

      Represents a segment of video or other time-delimited data.

      • FragmentNumber (string) --

        The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

      • FragmentSizeInBytes (integer) --

        The total fragment size, including information about the fragment and contained media data.

      • ProducerTimestamp (datetime) --

        The timestamp from the producer corresponding to the fragment.

      • ServerTimestamp (datetime) --

        The timestamp from the AWS server corresponding to the fragment.

      • FragmentLengthInMilliseconds (integer) --

        The playback duration or other time value associated with the fragment.

  • NextToken (string) --

    If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value is null when there are no more results to return.