[ aws . amplify ]

list-apps

Description

Returns a list of the 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 | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

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

apps -> (list)

A list of Amplify apps.

(structure)

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

appId -> (string)

The unique ID of the Amplify app.

appArn -> (string)

The Amazon Resource Name (ARN) of the Amplify app.

name -> (string)

The name for the Amplify app.

tags -> (map)

The tag for the Amplify app.

key -> (string)

value -> (string)

description -> (string)

The description for the Amplify app.

repository -> (string)

The repository for the Amplify app.

platform -> (string)

The platform for the Amplify app.

createTime -> (timestamp)

Creates a date and time for the Amplify app.

updateTime -> (timestamp)

Updates the date and time for the Amplify app.

iamServiceRoleArn -> (string)

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

environmentVariables -> (map)

The environment variables for the Amplify app.

key -> (string)

value -> (string)

defaultDomain -> (string)

The default domain for the Amplify app.

enableBranchAutoBuild -> (boolean)

Enables the auto-building of branches for the Amplify app.

enableBranchAutoDeletion -> (boolean)

Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

enableBasicAuth -> (boolean)

Enables basic authorization for the Amplify app’s branches.

basicAuthCredentials -> (string)

The basic authorization credentials for branches for the Amplify app.

customRules -> (list)

Describes the custom redirect and rewrite rules for the Amplify app.

(structure)

Describes a custom rewrite or 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.

200

Represents a 200 rewrite rule.

301

Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

302

Represents a 302 temporary redirect rule.

404

Represents a 404 redirect rule.

404-200

Represents a 404 rewrite rule.

condition -> (string)

The condition for a URL rewrite or redirect rule, such as a country code.

productionBranch -> (structure)

Describes the information about a production branch of the Amplify app.

lastDeployTime -> (timestamp)

The last deploy time of the production branch.

status -> (string)

The status of the production branch.

thumbnailUrl -> (string)

The thumbnail URL for the production branch.

branchName -> (string)

The branch name for the production branch.

buildSpec -> (string)

Describes the content of the build specification (build spec) for the Amplify app.

customHeaders -> (string)

Describes the custom HTTP headers for the Amplify app.

enableAutoBranchCreation -> (boolean)

Enables automated branch creation for the Amplify app.

autoBranchCreationPatterns -> (list)

Describes the automated branch creation glob patterns for the Amplify app.

(string)

autoBranchCreationConfig -> (structure)

Describes the automated branch creation configuration for the Amplify app.

stage -> (string)

Describes the current stage for the autocreated branch.

framework -> (string)

The framework for the autocreated branch.

enableAutoBuild -> (boolean)

Enables auto building for the autocreated branch.

environmentVariables -> (map)

The environment variables for the autocreated branch.

key -> (string)

value -> (string)

basicAuthCredentials -> (string)

The basic authorization credentials for the autocreated branch.

enableBasicAuth -> (boolean)

Enables basic authorization for the autocreated branch.

enablePerformanceMode -> (boolean)

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

buildSpec -> (string)

The build specification (build spec) for the autocreated branch.

enablePullRequestPreview -> (boolean)

Enables pull request previews for the autocreated branch.

pullRequestEnvironmentName -> (string)

The Amplify environment name for the pull request.

nextToken -> (string)

A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.