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 ]

delete-branch

Description

Deletes a branch for an Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-branch
--app-id <value>
--branch-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an Amplify App.

--branch-name (string)

Name for the branch.

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

branch -> (structure)

Branch structure for an Amplify App.

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.