Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

list-backend-environments

Description

Lists backend environments for an Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-backend-environments
--app-id <value>
[--environment-name <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an amplify App.

--environment-name (string)

Name of the backend environment

--next-token (string)

Pagination token. Set to null to start listing backen environments from start. If a non-null pagination token is returned in a result, then pass its value in here to list more backend environments.

--max-results (integer)

Maximum number of records to list in a single response.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

backendEnvironments -> (list)

List of backend environments for an Amplify App.

(structure)

Backend environment for an Amplify App.

backendEnvironmentArn -> (string)

Arn for a backend environment, part of an Amplify App.

environmentName -> (string)

Name for a backend environment, part of an Amplify App.

stackName -> (string)

CloudFormation stack name of backend environment.

deploymentArtifacts -> (string)

Name of deployment artifacts.

createTime -> (timestamp)

Creation date and time for a backend environment, part of an Amplify App.

updateTime -> (timestamp)

Last updated date and time for a backend environment, part of an Amplify App.

nextToken -> (string)

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.