Table Of Contents

Feedback

User Guide

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

[ aws . amplify ]

list-branches

Description

Lists branches for an Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-branches 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: branches

Synopsis

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

Options

--app-id (string)

Unique Id for an Amplify App.

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

branches -> (list)

List of branches for an Amplify App.

(structure)

Branch for an Amplify App, which maps to a 3rd party repository branch.

branchArn -> (string)

ARN for a branch, part of an Amplify App.

branchName -> (string)

Name for a branch, part of an Amplify App.

description -> (string)

Description for a branch, part of an Amplify App.

tags -> (map)

Tag for branch for Amplify App.

key -> (string)

value -> (string)

stage -> (string)

Stage for a branch, part of an Amplify App.

displayName -> (string)

Display name for a branch, will use as the default domain prefix.

enableNotification -> (boolean)

Enables notifications for a branch, part of an Amplify App.

createTime -> (timestamp)

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

updateTime -> (timestamp)

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

environmentVariables -> (map)

Environment Variables specific to a branch, part of an Amplify App.

key -> (string)

value -> (string)

enableAutoBuild -> (boolean)

Enables auto-building on push for a branch, part of an Amplify App.

customDomains -> (list)

Custom domains for a branch, part of an Amplify App.

(string)

framework -> (string)

Framework for a branch, part of an Amplify App.

activeJobId -> (string)

Id of the active job for a branch, part of an Amplify App.

totalNumberOfJobs -> (string)

Total number of Jobs part of an Amplify App.

enableBasicAuth -> (boolean)

Enables Basic Authorization for a branch, part of an Amplify App.

thumbnailUrl -> (string)

Thumbnail URL for the branch.

basicAuthCredentials -> (string)

Basic Authorization credentials for a branch, part of an Amplify App.

buildSpec -> (string)

BuildSpec content for branch for Amplify App.

ttl -> (string)

The content TTL for the website in seconds.

associatedResources -> (list)

List of custom resources that are linked to this branch.

(string)

enablePullRequestPreview -> (boolean)

Enables Pull Request Preview for this branch.

pullRequestEnvironmentName -> (string)

The Amplify Environment name for the pull request.

destinationBranch -> (string)

The destination branch if the branch is a pull request branch.

sourceBranch -> (string)

The source branch if the branch is a pull request branch.

backendEnvironmentArn -> (string)

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