LISTFRAGMENTS()`¶

About ListFragments¶

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.

Method Signature¶

METHODS /AWS1/IF_KNA~LISTFRAGMENTS
  IMPORTING
    !IV_STREAMNAME TYPE /AWS1/KNASTREAMNAME OPTIONAL
    !IV_STREAMARN TYPE /AWS1/KNARESOURCEARN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/KNALISTFRAGMENTSMAXRSLTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KNANEXTTOKEN OPTIONAL
    !IO_FRAGMENTSELECTOR TYPE REF TO /AWS1/CL_KNAFRAGMENTSELECTOR OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knalistfragmentsout
  RAISING
    /AWS1/CX_KNACLIENTLIMITEXCDEX
    /AWS1/CX_KNAINVALIDARGUMENTEX
    /AWS1/CX_KNANOTAUTHORIZEDEX
    /AWS1/CX_KNARESOURCENOTFOUNDEX
    /AWS1/CX_KNACLIENTEXC
    /AWS1/CX_KNASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_streamname` `TYPE /AWS1/KNASTREAMNAME` `/AWS1/KNASTREAMNAME`¶

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

`iv_streamarn` `TYPE /AWS1/KNARESOURCEARN` `/AWS1/KNARESOURCEARN`¶

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

`iv_maxresults` `TYPE /AWS1/KNALISTFRAGMENTSMAXRSLTS` `/AWS1/KNALISTFRAGMENTSMAXRSLTS`¶

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

`iv_nexttoken` `TYPE /AWS1/KNANEXTTOKEN` `/AWS1/KNANEXTTOKEN`¶

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

`io_fragmentselector` `TYPE REF TO /AWS1/CL_KNAFRAGMENTSELECTOR` `/AWS1/CL_KNAFRAGMENTSELECTOR`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knalistfragmentsout` `/AWS1/CL_KNALISTFRAGMENTSOUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listfragments(
  io_fragmentselector = new /aws1/cl_knafragmentselector(
    io_timestamprange = new /aws1/cl_knatimestamprange(
      iv_endtimestamp = '20150101000000.0000000'
      iv_starttimestamp = '20150101000000.0000000'
    )
    iv_fragmentselectortype = |string|
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_streamarn = |string|
  iv_streamname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_fragments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_fragmentnumberstring = lo_row_1->get_fragmentnumber( ).
      lv_long = lo_row_1->get_fragmentsizeinbytes( ).
      lv_timestamp = lo_row_1->get_producertimestamp( ).
      lv_timestamp = lo_row_1->get_servertimestamp( ).
      lv_long = lo_row_1->get_fragmentlengthinmillis00( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_KNA=>LISTFRAGMENTS()¶