[ aws . amplify ]

list-branches

Description

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

Options

--app-id (string)

The unique ID for an Amplify app.

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

branches -> (list)

A list of branches for an Amplify app.

(structure)

The branch for an Amplify app, which maps to a third-party repository branch.

branchArn -> (string)

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

branchName -> (string)

The name for the branch that is part of an Amplify app.

description -> (string)

The description for the branch that is part of an Amplify app.

tags -> (map)

The tag for the branch of an Amplify app.

key -> (string)

value -> (string)

stage -> (string)

The current stage for the branch that is part of an Amplify app.

displayName -> (string)

The display name for the branch. This is used as the default domain prefix.

enableNotification -> (boolean)

Enables notifications for a branch that is part of an Amplify app.

createTime -> (timestamp)

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

updateTime -> (timestamp)

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

environmentVariables -> (map)

The environment variables specific to a branch of an Amplify app.

key -> (string)

value -> (string)

enableAutoBuild -> (boolean)

Enables auto-building on push for a branch of an Amplify app.

customDomains -> (list)

The custom domains for a branch of an Amplify app.

(string)

framework -> (string)

The framework for a branch of an Amplify app.

activeJobId -> (string)

The ID of the active job for a branch of an Amplify app.

totalNumberOfJobs -> (string)

The total number of jobs that are part of an Amplify app.

enableBasicAuth -> (boolean)

Enables basic authorization for a branch of an Amplify app.

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.

thumbnailUrl -> (string)

The thumbnail URL for the branch of an Amplify app.

basicAuthCredentials -> (string)

The basic authorization credentials for a branch of an Amplify app.

buildSpec -> (string)

The build specification (build spec) content for the branch of an Amplify app.

ttl -> (string)

The content Time to Live (TTL) for the website in seconds.

associatedResources -> (list)

A list of custom resources that are linked to this branch.

(string)

enablePullRequestPreview -> (boolean)

Enables pull request previews for the 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)

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

nextToken -> (string)

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