Table of Contents
KinesisVideoMedia.Client¶A low-level client representing Amazon Kinesis Video Streams Media (Kinesis Video Media)
import boto3
client = boto3.client('kinesis-video-media')
These are the available methods:
can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
get_media(**kwargs)¶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.
Note
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:
GetMedia up to five times per second per stream.GetMedia session.Note
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.
See also: AWS API Documentation
Request Syntax
response = client.get_media(
StreamName='string',
StreamARN='string',
StartSelector={
'StartSelectorType': 'FRAGMENT_NUMBER'|'SERVER_TIMESTAMP'|'PRODUCER_TIMESTAMP'|'NOW'|'EARLIEST'|'CONTINUATION_TOKEN',
'AfterFragmentNumber': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'ContinuationToken': 'string'
}
)
streamName , you must specify the streamARN .streamARN , you must specify the streamName .[REQUIRED]
Identifies the starting chunk to get from the specified stream.
Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
AfterFragmentNumber parameter.StartTimestamp .Note
If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType , you don't provide any additional information in the startSelector .
Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType . The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp.
Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.
dict
Response Syntax
{
'ContentType': 'string',
'Payload': StreamingBody()
}
Response Structure
(dict) --
ContentType (string) --
The content type of the requested media.
Payload (StreamingBody) --
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:
GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.The following tags will be present if an error occurs:
The error codes are as follows:
Exceptions
KinesisVideoMedia.Client.exceptions.ResourceNotFoundExceptionKinesisVideoMedia.Client.exceptions.NotAuthorizedExceptionKinesisVideoMedia.Client.exceptions.InvalidEndpointExceptionKinesisVideoMedia.Client.exceptions.ClientLimitExceededExceptionKinesisVideoMedia.Client.exceptions.ConnectionLimitExceededExceptionKinesisVideoMedia.Client.exceptions.InvalidArgumentExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
The available paginators are: