AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

For limits, see Kinesis Video Streams Limits.

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 Amazon Web Services, 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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetMediaForFragmentList and EndGetMediaForFragmentList.

Namespace: Amazon.KinesisVideoArchivedMedia
Assembly: AWSSDK.KinesisVideoArchivedMedia.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<GetMediaForFragmentListResponse> GetMediaForFragmentListAsync(
         GetMediaForFragmentListRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.KinesisVideoArchivedMedia.Model.GetMediaForFragmentListRequest

Container for the necessary parameters to execute the GetMediaForFragmentList service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetMediaForFragmentList service method, as returned by KinesisVideoArchivedMedia.

Exceptions

ExceptionCondition
ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits.
InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.
NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.
ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified. GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also