Backend appId Details - Amplify Admin UI

Backend appId Details

Project-level details for your Amplify project.

URI

/prod/backend/appId/details

HTTP methods

POST

Operation ID: GetBackend

Provides project-level details for your Amplify UI project.

Path parameters
Name Type Required Description
appId String True

The app ID.

Responses
Status code Response model Description
200 GetBackendRespObj

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.

Path parameters
Name Type Required Description
appId String True

The app ID.

Responses
Status code Response model Description
200 None

200 response

Schemas

Request bodies

{ "backendEnvironmentName": "string" }

Response bodies

{ "appName": "string", "appId": "string", "backendEnvironmentList": [ "string" ], "amplifyFeatureFlags": "string", "error": "string", "amplifyMetaConfig": "string", "backendEnvironmentName": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "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.

GetBackendReqObj

The request object for this operation.

Property Type Required Description
backendEnvironmentName

string

False

The name of the backend environment.

GetBackendRespObj

The response object for this operation.

Property Type Required Description
appName

string

False

The name of the app.

appId

string

True

The app ID.

backendEnvironmentList

Array of type string

False

A list of backend environments in an array.

amplifyFeatureFlags

string

False

A stringified version of the cli.json file for your Amplify project.

error

string

False

If the request failed, this is the returned error.

amplifyMetaConfig

string

False

A stringified version of the current configs for your Amplify project.

backendEnvironmentName

string

False

The name of the backend environment.

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
message

string

False

An error message to inform that the request has failed.

limitType

string

False

The type of limit that was exceeded.

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:

GetBackend