Table Of Contents

Feedback

User Guide

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

[ aws . amplify ]

list-apps

Description

Lists existing Amplify Apps.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-apps is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: apps

Synopsis

  list-apps
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

apps -> (list)

List of Amplify Apps.

(structure)

Amplify App represents different branches of a repository for building, deploying, and hosting.

appId -> (string)

Unique Id for the Amplify App.

appArn -> (string)

ARN for the Amplify App.

name -> (string)

Name for the Amplify App.

tags -> (map)

Tag for Amplify App.

key -> (string)

value -> (string)

description -> (string)

Description for the Amplify App.

repository -> (string)

Repository for the Amplify App.

platform -> (string)

Platform for the Amplify App.

createTime -> (timestamp)

Create date / time for the Amplify App.

updateTime -> (timestamp)

Update date / time for the Amplify App.

iamServiceRoleArn -> (string)

IAM service role ARN for the Amplify App.

environmentVariables -> (map)

Environment Variables for the Amplify App.

key -> (string)

value -> (string)

defaultDomain -> (string)

Default domain for the Amplify App.

enableBranchAutoBuild -> (boolean)

Enables auto-building of branches for the Amplify App.

enableBasicAuth -> (boolean)

Enables Basic Authorization for branches for the Amplify App.

basicAuthCredentials -> (string)

Basic Authorization credentials for branches for the Amplify App.

customRules -> (list)

Custom redirect / rewrite rules for the Amplify App.

(structure)

Custom rewrite / redirect rule.

source -> (string)

The source pattern for a URL rewrite or redirect rule.

target -> (string)

The target pattern for a URL rewrite or redirect rule.

status -> (string)

The status code for a URL rewrite or redirect rule.

condition -> (string)

The condition for a URL rewrite or redirect rule, e.g. country code.

productionBranch -> (structure)

Structure with Production Branch information.

lastDeployTime -> (timestamp)

Last Deploy Time of Production Branch.

status -> (string)

Status of Production Branch.

thumbnailUrl -> (string)

Thumbnail URL for Production Branch.

branchName -> (string)

Branch Name for Production Branch.

buildSpec -> (string)

BuildSpec content for Amplify App.

enableAutoBranchCreation -> (boolean)

Enables automated branch creation for the Amplify App.

autoBranchCreationPatterns -> (list)

Automated branch creation glob patterns for the Amplify App.

(string)

autoBranchCreationConfig -> (structure)

Automated branch creation config for the Amplify App.

stage -> (string)

Stage for the auto created branch.

framework -> (string)

Framework for the auto created branch.

enableAutoBuild -> (boolean)

Enables auto building for the auto created branch.

environmentVariables -> (map)

Environment Variables for the auto created branch.

key -> (string)

value -> (string)

basicAuthCredentials -> (string)

Basic Authorization credentials for the auto created branch.

enableBasicAuth -> (boolean)

Enables Basic Auth for the auto created branch.

buildSpec -> (string)

BuildSpec for the auto created branch.

enablePullRequestPreview -> (boolean)

Enables Pull Request Preview for auto created branch.

pullRequestEnvironmentName -> (string)

The Amplify Environment name for the pull request.

nextToken -> (string)

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