Skip to content

/AWS1/CL_AMF=>LISTBACKENDENVIRONMENTS()

About ListBackendEnvironments

Lists the backend environments for an Amplify app.

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

Method Signature

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