Skip to content
AWS for Query.Farm

aws.kinesis_video_archived_media.list_fragments

Example SQL Queries

SELECT * FROM
aws.kinesis_video_archived_media.list_fragments;

Description

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.

Table Definition

Column NameColumn Data Type
fragment_selector Input Column

Describes the timestamp range and timestamp origin for the range of fragments to return.

This is only required when the NextToken isn't passed in the API.

STRUCT(
    "fragment_selector_type" VARCHAR,
    "timestamp_range" STRUCT(
        "start_timestamp" TIMESTAMP_S,
        "end_timestamp" TIMESTAMP_S
    )
)
Show child fields
fragment_selector.fragment_selector_type

The origin of the timestamps to use (Server or Producer).

fragment_selector.timestamp_range

The range of timestamps to return.

Show child fields
fragment_selector.timestamp_range.end_timestamp

The ending timestamp in the range of timestamps for which to return fragments.

fragment_selector.timestamp_range.start_timestamp

The starting timestamp in the range of timestamps for which to return fragments.

stream_arn Input Column

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

VARCHAR
stream_name Input Column

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

fragment_length_in_milliseconds

The playback duration or other time value associated with the fragment.

BIGINT
fragment_number

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

VARCHAR
fragment_size_in_bytes

The total fragment size, including information about the fragment and contained media data.

BIGINT
producer_timestamp

The timestamp from the producer corresponding to the fragment.

TIMESTAMP_S
server_timestamp

The timestamp from the Amazon Web Services server corresponding to the fragment.

TIMESTAMP_S