Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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.

Request Syntax


GET /apps/appId/backendenvironments?environmentName=environmentName&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes

environmentName

The name of the backend environment

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

maxResults

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

Valid Range: Minimum value of 0. Maximum value of 50.

nextToken

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.

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "backendEnvironments": [ 
      { 
         "backendEnvironmentArn": "string",
         "createTime": number,
         "deploymentArtifacts": "string",
         "environmentName": "string",
         "stackName": "string",
         "updateTime": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

backendEnvironments

The list of backend environments for an Amplify app.

Type: Array of BackendEnvironment objects

nextToken

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Type: String

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401