LISTSTREAMURLS()`¶

About ListStreamUrls¶

Retrieves a list of the stream URLs in the current Amazon Web Services Region for your Amazon Web Services account. You can filter the results by status or by stream group. Use the pagination parameters to retrieve results as a set of sequential pages. If you delete the stream group or application that backs a stream URL, this operation updates that stream URL's status to REVOKED.

Method Signature¶

METHODS /AWS1/IF_GMZ~LISTSTREAMURLS
  IMPORTING
    !IV_STATUS TYPE /AWS1/GMZSTREAMURLSTATUS OPTIONAL
    !IV_STREAMGROUPIDENTIFIER TYPE /AWS1/GMZIDENTIFIER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GMZNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/GMZMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmzliststrmurlsoutput
  RAISING
    /AWS1/CX_GMZACCESSDENIEDEX
    /AWS1/CX_GMZINTERNALSERVEREX
    /AWS1/CX_GMZTHROTTLINGEX
    /AWS1/CX_GMZVALIDATIONEX
    /AWS1/CX_GMZCLIENTEXC
    /AWS1/CX_GMZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_status` `TYPE /AWS1/GMZSTREAMURLSTATUS` `/AWS1/GMZSTREAMURLSTATUS`¶

Filters the list to stream URLs with the specified status.

ACTIVE: The stream URL is valid and can start stream sessions.

EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

REVOKED: The stream URL was revoked and can no longer start stream sessions.

LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

`iv_streamgroupidentifier` `TYPE /AWS1/GMZIDENTIFIER` `/AWS1/GMZIDENTIFIER`¶

Filters the list to stream URLs that belong to the specified stream group.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

`iv_nexttoken` `TYPE /AWS1/GMZNEXTTOKEN` `/AWS1/GMZNEXTTOKEN`¶

The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

`iv_maxresults` `TYPE /AWS1/GMZMAXRESULTS` `/AWS1/GMZMAXRESULTS`¶

The maximum number of results to return per page. Valid values are 1-100. The default is 25.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmzliststrmurlsoutput` `/AWS1/CL_GMZLISTSTRMURLSOUTPUT`¶

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->liststreamurls(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |string|
  iv_streamgroupidentifier = |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_arn = lo_row_1->get_arn( ).
      lv_id = lo_row_1->get_streamurlid( ).
      lv_streamsessionstreamurl = lo_row_1->get_streamurl( ).
      lv_streamurlstatus = lo_row_1->get_status( ).
      lv_streamurlstatusreason = lo_row_1->get_statusreason( ).
      lv_timestamp = lo_row_1->get_expiresat( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_usagelimit = lo_row_1->get_usagelimit( ).
      lv_remaininguses = lo_row_1->get_remaininguses( ).
      lv_arn = lo_row_1->get_streamgrouparn( ).
      lv_arn = lo_row_1->get_applicationarn( ).
      lv_sessionlengthseconds = lo_row_1->get_sessionlengthseconds( ).
      lv_description = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GMZ=>LISTSTREAMURLS()¶