GET

/apps/{appId}/backendenvironments

http://amplify.{region}.amazonaws.com/apps/{appId}/backendenvironments

Lists the backend environments for an Amplify app.

Access Token Required: API Key

Path Parameters

appIdstringrequired

The unique ID for an Amplify app.

Query Params

environmentNamestring

The name of the backend environment

nextTokenstring

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.

maxResultsinteger

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://amplify.{region}.amazonaws.com/apps/{appId}/backendenvironments' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET