[ aws . amplifybackend ]

get-backend

Description

Provides project-level details for your Amplify UI project.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-backend
--app-id <value>
[--backend-environment-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The app ID.

--backend-environment-name (string)

The name of the backend environment.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AmplifyMetaConfig -> (string)

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

AppId -> (string)

The app ID.

AppName -> (string)

The name of the app.

BackendEnvironmentList -> (list)

A list of backend environments in an array.

(string)

BackendEnvironmentName -> (string)

The name of the backend environment.

Error -> (string)

If the request failed, this is the returned error.