GetBackendEnvironmentCommand

Use a bare-bones client and the command you need to make an API call.

GetBackendEnvironmentCommandInput

[GetBackendEnvironmentCommandInput](@aws-sdk/client-amplify!GetBackendEnvironmentCommandInput:Interface)

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.

appId

The unique id for an Amplify app.

environmentName

The name for the backend environment.

The input for [GetBackendEnvironmentCommand](@aws-sdk/client-amplify!GetBackendEnvironmentCommand:Class).

$metadata

backendEnvironment

Describes the backend environment for an Amplify app.

GetBackendEnvironmentCommandOutput

The output of [GetBackendEnvironmentCommand](@aws-sdk/client-amplify!GetBackendEnvironmentCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

name

BadRequestException

A request contains unexpected data.

InternalFailureException

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

NotFoundException

An entity was not found during an operation.

UnauthorizedException

An operation failed due to a lack of access.

AmplifyServiceException

Base exception class for all service exceptions from Amplify service.