[ aws . amplify ]

get-backend-environment

Description

Returns a backend environment for an Amplify app.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--app-id (string)

The unique id for an Amplify app.

--environment-name (string)

The name for 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

backendEnvironment -> (structure)

Describes the backend environment for an Amplify app.

backendEnvironmentArn -> (string)

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

environmentName -> (string)

The name for a backend environment that is part of an Amplify app.

stackName -> (string)

The AWS CloudFormation stack name of a backend environment.

deploymentArtifacts -> (string)

The name of deployment artifacts.

createTime -> (timestamp)

The creation date and time for a backend environment that is part of an Amplify app.

updateTime -> (timestamp)

The last updated date and time for a backend environment that is part of an Amplify app.