fragments
Creates, updates, deletes, gets or lists a fragments resource.
Overview
| Name | fragments |
| Type | Resource |
| Id | aws.kinesis_video_archived_media.fragments |
Fields
The following fields are returned by SELECT queries:
- list_fragments
| Name | Datatype | Description |
|---|---|---|
fragment_length_in_milliseconds | integer (int64) | The playback duration or other time value associated with the fragment. |
fragment_number | string | The unique identifier of the fragment. This value monotonically increases based on the ingestion order. (pattern: <code>^[0-9]+$</code>) |
fragment_size_in_bytes | integer (int64) | The total fragment size, including information about the fragment and contained media data. |
producer_timestamp | string (date-time) | The timestamp from the producer corresponding to the fragment. |
server_timestamp | string (date-time) | The timestamp from the Amazon Web Services server corresponding to the fragment. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_fragments | select | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_fragments
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.
SELECT
fragment_length_in_milliseconds,
fragment_number,
fragment_size_in_bytes,
producer_timestamp,
server_timestamp
FROM aws.kinesis_video_archived_media.fragments
WHERE region = '{{ region }}' -- required
;