Amazonka.KinesisVideoMedia.GetMedia

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.

Creating a Request

data GetMedia

See: newGetMedia smart constructor.

Constructors

GetMedia'

Fields

• streamARN :: Maybe Text

  The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName.

• streamName :: Maybe Text

  The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN.

• startSelector :: StartSelector

  Identifies the starting chunk to get from the specified stream.

Instances

ToJSON GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

toJSON :: GetMedia -> Value

toEncoding :: GetMedia -> Encoding

toJSONList :: [GetMedia] -> Value

toEncodingList :: [GetMedia] -> Encoding

ToHeaders GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

toHeaders :: GetMedia -> [Header]

ToPath GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

toPath :: GetMedia -> ByteString

ToQuery GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

toQuery :: GetMedia -> QueryString

AWSRequest GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Associated Types

type AWSResponse GetMedia

Methods

request :: (Service -> Service) -> GetMedia -> Request GetMedia

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMedia -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMedia)))

Generic GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Associated Types

type Rep GetMedia :: Type -> Type

Methods

from :: GetMedia -> Rep GetMedia x

to :: Rep GetMedia x -> GetMedia

Read GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

readsPrec :: Int -> ReadS GetMedia

readList :: ReadS [GetMedia]

readPrec :: ReadPrec GetMedia

readListPrec :: ReadPrec [GetMedia]

Show GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

showsPrec :: Int -> GetMedia -> ShowS

show :: GetMedia -> String

showList :: [GetMedia] -> ShowS

NFData GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

rnf :: GetMedia -> ()

Eq GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

(==) :: GetMedia -> GetMedia -> Bool

(/=) :: GetMedia -> GetMedia -> Bool

Hashable GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

hashWithSalt :: Int -> GetMedia -> Int

hash :: GetMedia -> Int

type AWSResponse GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

type AWSResponse GetMedia = GetMediaResponse

type Rep GetMedia

Defined in Amazonka.KinesisVideoMedia.GetMedia

type Rep GetMedia = D1 ('MetaData "GetMedia" "Amazonka.KinesisVideoMedia.GetMedia" "amazonka-kinesis-video-media-2.0-8H5b1pPJy7EDyfUB3Ys1cI" 'False) (C1 ('MetaCons "GetMedia'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StartSelector))))

newGetMedia

Arguments

:: StartSelector

$sel:startSelector:GetMedia'

-> GetMedia

Create a value of GetMedia with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamARN:GetMedia', getMedia_streamARN - The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName.

$sel:streamName:GetMedia', getMedia_streamName - The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN.

$sel:startSelector:GetMedia', getMedia_startSelector - Identifies the starting chunk to get from the specified stream.

Request Lenses

getMedia_streamARN :: Lens' GetMedia (Maybe Text)

The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName.

getMedia_streamName :: Lens' GetMedia (Maybe Text)

The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN.

getMedia_startSelector :: Lens' GetMedia StartSelector

Identifies the starting chunk to get from the specified stream.

Destructuring the Response

data GetMediaResponse

See: newGetMediaResponse smart constructor.

Constructors

GetMediaResponse'

Fields

• contentType :: Maybe Text

  The content type of the requested media.

• httpStatus :: Int

  The response's http status code.

• payload :: ResponseBody

  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

Instances

Generic GetMediaResponse

Defined in Amazonka.KinesisVideoMedia.GetMedia

Associated Types

type Rep GetMediaResponse :: Type -> Type

Methods

from :: GetMediaResponse -> Rep GetMediaResponse x

to :: Rep GetMediaResponse x -> GetMediaResponse

Show GetMediaResponse

Defined in Amazonka.KinesisVideoMedia.GetMedia

Methods

showsPrec :: Int -> GetMediaResponse -> ShowS

show :: GetMediaResponse -> String

showList :: [GetMediaResponse] -> ShowS

type Rep GetMediaResponse

Defined in Amazonka.KinesisVideoMedia.GetMedia

type Rep GetMediaResponse = D1 ('MetaData "GetMediaResponse" "Amazonka.KinesisVideoMedia.GetMedia" "amazonka-kinesis-video-media-2.0-8H5b1pPJy7EDyfUB3Ys1cI" 'False) (C1 ('MetaCons "GetMediaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody))))

newGetMediaResponse

Arguments

:: Int

$sel:httpStatus:GetMediaResponse'

-> ResponseBody

$sel:payload:GetMediaResponse'

-> GetMediaResponse

Create a value of GetMediaResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:GetMediaResponse', getMediaResponse_contentType - The content type of the requested media.

$sel:httpStatus:GetMediaResponse', getMediaResponse_httpStatus - The response's http status code.

$sel:payload:GetMediaResponse', getMediaResponse_payload - 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

Response Lenses

getMediaResponse_contentType :: Lens' GetMediaResponse (Maybe Text)

The content type of the requested media.

getMediaResponse_httpStatus :: Lens' GetMediaResponse Int

The response's http status code.

getMediaResponse_payload :: Lens' GetMediaResponse ResponseBody

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