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

CreateBackendEnvironment

Creates a new 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


POST /apps/appId/backendenvironments HTTP/1.1
Content-type: application/json

{
   "deploymentArtifacts": "string",
   "environmentName": "string",
   "stackName": "string"
}

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

Request Body

The request accepts the following data in JSON format.

deploymentArtifacts

The name of deployment artifacts.

Type: String

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

Pattern: (?s).+

Required: No

environmentName

The name for the backend environment.

Type: String

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

Pattern: (?s).+

Required: Yes

stackName

The AWS CloudFormation stack name of a backend environment.

Type: String

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

Pattern: (?s).+

Required: No

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.

backendEnvironment

Describes the backend environment for an Amplify app.

Type: BackendEnvironment object

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

LimitExceededException

A resource could not be created because service quotas were exceeded.

HTTP Status Code: 429

NotFoundException

An entity was not found during an operation.

HTTP Status Code: 404

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401