Backend appId Environments backendEnvironmentName Clone
A clone of an existing environment in your Amplify project.
URI
/prod/backend/appId/environments/backendEnvironmentName/clone
HTTP methods
POST
Operation ID: CloneBackend
This operation clones an existing backend.
| Name | Type | Required | Description |
|---|---|---|---|
appId | String | True | The app ID. |
backendEnvironmentName | String | True | The name of the backend environment. |
| Status code | Response model | Description |
|---|---|---|
200 | CloneBackendRespObj | 200 response |
400 | BadRequestException | 400 response |
404 | NotFoundException | 404 response |
429 | LimitExceededException | 429 response |
504 | InternalServiceException | 504 response |
OPTIONS
Enables CORS by returning the correct headers.
| Name | Type | Required | Description |
|---|---|---|---|
appId | String | True | The app ID. |
backendEnvironmentName | String | True | The name of the backend environment. |
| Status code | Response model | Description |
|---|---|---|
200 | None | 200 response |
Schemas
Request bodies
{ "targetEnvironmentName": "string" }
Response bodies
{ "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
BadRequestException
An error returned if a request is not formed properly.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | An error message to inform that the request failed. |
CloneBackendReqObj
The request object for this operation.
| Property | Type | Required | Description |
|---|---|---|---|
targetEnvironmentName | string | True | The name of the destination backend environment to be created. |
CloneBackendRespObj
The response object sent when a backend is created.
| Property | Type | Required | Description |
|---|---|---|---|
appId | string | True | The app ID. |
backendEnvironmentName | string | True | The name of the backend environment. |
error | string | False | If the request fails, this error is returned. |
jobId | string | False | The ID for the job. |
operation | string | False | The name of the operation. |
status | string | False | The current status of the request. |
InternalServiceException
An error returned if there's a temporary issue with the service.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | An error message to inform that the request failed. |
LimitExceededException
An error that is returned when a limit of a specific type has been exceeded.
| Property | Type | Required | Description |
|---|---|---|---|
limitType | string | False | The type of limit that was exceeded. |
message | string | False | An error message to inform that the request has failed. |
NotFoundException
An error returned when a specific resource type is not found.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | An error message to inform that the request has failed. |
resourceType | string | False | The type of resource that is not found. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
CloneBackend
Warning Javascript is disabled or is unavailable in your browser.
To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.