GetBackendEnvironment - Amplify


Returns a backend environment 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 HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The unique id for an Amplify app.

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

Pattern: d[a-z0-9]+

Required: Yes


The name for the backend environment.

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

Pattern: (?s).+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "backendEnvironment": { "backendEnvironmentArn": "string", "createTime": number, "deploymentArtifacts": "string", "environmentName": "string", "stackName": "string", "updateTime": number } }

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.


Describes the backend environment for an Amplify app.

Type: BackendEnvironment object


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


A request contains unexpected data.

HTTP Status Code: 400


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

HTTP Status Code: 500


An entity was not found during an operation.

HTTP Status Code: 404


An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: