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.

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.

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

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:

For .NET Core this operation is only available in asynchronous form. Please refer to ListFragmentsAsync.

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

Syntax

C#
public virtual ListFragmentsResponse ListFragments(
         ListFragmentsRequest request
)

Parameters

request
Type: Amazon.KinesisVideoArchivedMedia.Model.ListFragmentsRequest

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

Return Value


The response from the ListFragments 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 Framework:
Supported in: 4.5, 4.0, 3.5

See Also