LISTBACKENDENVIRONMENTS()`¶

About ListBackendEnvironments¶

Lists the backend environments for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Method Signature¶

METHODS /AWS1/IF_AMF~LISTBACKENDENVIRONMENTS
  IMPORTING
    !IV_APPID TYPE /AWS1/AMFAPPID OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/AMFENVIRONMENTNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/AMFNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/AMFMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amflstbackendenviro01
  RAISING
    /AWS1/CX_AMFBADREQUESTEX
    /AWS1/CX_AMFINTERNALFAILUREEX
    /AWS1/CX_AMFUNAUTHORIZEDEX
    /AWS1/CX_AMFCLIENTEXC
    /AWS1/CX_AMFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appid` `TYPE /AWS1/AMFAPPID` `/AWS1/AMFAPPID`¶

The unique ID for an Amplify app.

Optional arguments:¶

`iv_environmentname` `TYPE /AWS1/AMFENVIRONMENTNAME` `/AWS1/AMFENVIRONMENTNAME`¶

The name of the backend environment

`iv_nexttoken` `TYPE /AWS1/AMFNEXTTOKEN` `/AWS1/AMFNEXTTOKEN`¶

A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

`iv_maxresults` `TYPE /AWS1/AMFMAXRESULTS` `/AWS1/AMFMAXRESULTS`¶

The maximum number of records to list in a single response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_amflstbackendenviro01` `/AWS1/CL_AMFLSTBACKENDENVIRO01`¶

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->listbackendenvironments(
  iv_appid = |string|
  iv_environmentname = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_backendenvironments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_backendenvironmentarn = lo_row_1->get_backendenvironmentarn( ).
      lv_environmentname = lo_row_1->get_environmentname( ).
      lv_stackname = lo_row_1->get_stackname( ).
      lv_deploymentartifacts = lo_row_1->get_deploymentartifacts( ).
      lv_createtime = lo_row_1->get_createtime( ).
      lv_updatetime = lo_row_1->get_updatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_AMF=>LISTBACKENDENVIRONMENTS()¶