Skip to content

/AWS1/IF_MDT=>LISTPREFETCHSCHEDULES()

About ListPrefetchSchedules

Lists the prefetch schedules for a playback configuration.

Method Signature

METHODS /AWS1/IF_MDT~LISTPREFETCHSCHEDULES
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/MDT__INTEGERMIN1MAX100 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MDT__STRING OPTIONAL
    !IV_PLAYBACKCONFIGURATIONNAME TYPE /AWS1/MDT__STRING OPTIONAL
    !IV_SCHEDULETYPE TYPE /AWS1/MDTLISTPREFETCHSCHDTYPE OPTIONAL
    !IV_STREAMID TYPE /AWS1/MDT__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdtlstprefetchschsrsp
  RAISING
    /AWS1/CX_MDTCLIENTEXC
    /AWS1/CX_MDTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_playbackconfigurationname TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

Retrieves the prefetch schedule(s) for a specific playback configuration.

Optional arguments:

iv_maxresults TYPE /AWS1/MDT__INTEGERMIN1MAX100 /AWS1/MDT__INTEGERMIN1MAX100

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

iv_nexttoken TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

iv_scheduletype TYPE /AWS1/MDTLISTPREFETCHSCHDTYPE /AWS1/MDTLISTPREFETCHSCHDTYPE

The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

iv_streamid TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

RETURNING

oo_output TYPE REF TO /aws1/cl_mdtlstprefetchschsrsp /AWS1/CL_MDTLSTPREFETCHSCHSRSP

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->listprefetchschedules(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_playbackconfigurationname = |string|
  iv_scheduletype = |string|
  iv_streamid = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv___string = lo_row_1->get_arn( ).
      lo_prefetchconsumption = lo_row_1->get_consumption( ).
      IF lo_prefetchconsumption IS NOT INITIAL.
        LOOP AT lo_prefetchconsumption->get_availmatchingcriteria( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv___string = lo_row_3->get_dynamicvariable( ).
            lv_operator = lo_row_3->get_operator( ).
          ENDIF.
        ENDLOOP.
        lv___timestampunix = lo_prefetchconsumption->get_endtime( ).
        lv___timestampunix = lo_prefetchconsumption->get_starttime( ).
      ENDIF.
      lv___string = lo_row_1->get_name( ).
      lv___string = lo_row_1->get_playbackconfname( ).
      lo_prefetchretrieval = lo_row_1->get_retrieval( ).
      IF lo_prefetchretrieval IS NOT INITIAL.
        LOOP AT lo_prefetchretrieval->get_dynamicvariables( ) into ls_row_4.
          lv_key = ls_row_4-key.
          lo_value = ls_row_4-value.
          IF lo_value IS NOT INITIAL.
            lv___string = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        lv___timestampunix = lo_prefetchretrieval->get_endtime( ).
        lv___timestampunix = lo_prefetchretrieval->get_starttime( ).
        lv_trafficshapingtype = lo_prefetchretrieval->get_trafficshapingtype( ).
        lo_trafficshapingretrieval = lo_prefetchretrieval->get_trafshapingretrievalwi00( ).
        IF lo_trafficshapingretrieval IS NOT INITIAL.
          lv___integer = lo_trafficshapingretrieval->get_retrievalwindowdursecs( ).
        ENDIF.
        lo_trafficshapingtpsconfig = lo_prefetchretrieval->get_trafficshapingtpsconf( ).
        IF lo_trafficshapingtpsconfig IS NOT INITIAL.
          lv___integer = lo_trafficshapingtpsconfig->get_peaktps( ).
          lv___integer = lo_trafficshapingtpsconfig->get_peakconcurrentusers( ).
        ENDIF.
      ENDIF.
      lv_prefetchscheduletype = lo_row_1->get_scheduletype( ).
      lo_recurringprefetchconfig = lo_row_1->get_recurringprefetchconf( ).
      IF lo_recurringprefetchconfig IS NOT INITIAL.
        lv___timestampunix = lo_recurringprefetchconfig->get_starttime( ).
        lv___timestampunix = lo_recurringprefetchconfig->get_endtime( ).
        lo_recurringconsumption = lo_recurringprefetchconfig->get_recurringconsumption( ).
        IF lo_recurringconsumption IS NOT INITIAL.
          lv___integer = lo_recurringconsumption->get_retrievedadexpirseconds( ).
          LOOP AT lo_recurringconsumption->get_availmatchingcriteria( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv___string = lo_row_3->get_dynamicvariable( ).
              lv_operator = lo_row_3->get_operator( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lo_recurringretrieval = lo_recurringprefetchconfig->get_recurringretrieval( ).
        IF lo_recurringretrieval IS NOT INITIAL.
          LOOP AT lo_recurringretrieval->get_dynamicvariables( ) into ls_row_4.
            lv_key = ls_row_4-key.
            lo_value = ls_row_4-value.
            IF lo_value IS NOT INITIAL.
              lv___string = lo_value->get_value( ).
            ENDIF.
          ENDLOOP.
          lv___integer = lo_recurringretrieval->get_delayafteravailendsecs( ).
          lv_trafficshapingtype = lo_recurringretrieval->get_trafficshapingtype( ).
          lo_trafficshapingretrieval = lo_recurringretrieval->get_trafshapingretrievalwi00( ).
          IF lo_trafficshapingretrieval IS NOT INITIAL.
            lv___integer = lo_trafficshapingretrieval->get_retrievalwindowdursecs( ).
          ENDIF.
          lo_trafficshapingtpsconfig = lo_recurringretrieval->get_trafficshapingtpsconf( ).
          IF lo_trafficshapingtpsconfig IS NOT INITIAL.
            lv___integer = lo_trafficshapingtpsconfig->get_peaktps( ).
            lv___integer = lo_trafficshapingtpsconfig->get_peakconcurrentusers( ).
          ENDIF.
        ENDIF.
      ENDIF.
      lv___string = lo_row_1->get_streamid( ).
    ENDIF.
  ENDLOOP.
  lv___string = lo_result->get_nexttoken( ).
ENDIF.