amazonka-codecommit-2.0: Amazon CodeCommit SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeCommit.DeleteBranch

Description

Deletes a branch from a repository, unless that branch is the default branch for the repository.

Synopsis

Creating a Request

data DeleteBranch Source #

Represents the input of a delete branch operation.

See: newDeleteBranch smart constructor.

Constructors

DeleteBranch' 

Fields

Instances

Instances details
ToJSON DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

ToHeaders DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

ToPath DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

ToQuery DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

AWSRequest DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Associated Types

type AWSResponse DeleteBranch #

Generic DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Associated Types

type Rep DeleteBranch :: Type -> Type #

Read DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Show DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

NFData DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Methods

rnf :: DeleteBranch -> () #

Eq DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Hashable DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

type AWSResponse DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

type Rep DeleteBranch Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

type Rep DeleteBranch = D1 ('MetaData "DeleteBranch" "Amazonka.CodeCommit.DeleteBranch" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "DeleteBranch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteBranch Source #

Create a value of DeleteBranch with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteBranch, deleteBranch_repositoryName - The name of the repository that contains the branch to be deleted.

DeleteBranch, deleteBranch_branchName - The name of the branch to delete.

Request Lenses

deleteBranch_repositoryName :: Lens' DeleteBranch Text Source #

The name of the repository that contains the branch to be deleted.

deleteBranch_branchName :: Lens' DeleteBranch Text Source #

The name of the branch to delete.

Destructuring the Response

data DeleteBranchResponse Source #

Represents the output of a delete branch operation.

See: newDeleteBranchResponse smart constructor.

Constructors

DeleteBranchResponse' 

Fields

  • deletedBranch :: Maybe BranchInfo

    Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Associated Types

type Rep DeleteBranchResponse :: Type -> Type #

Read DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Show DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

NFData DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

Methods

rnf :: DeleteBranchResponse -> () #

Eq DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

type Rep DeleteBranchResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteBranch

type Rep DeleteBranchResponse = D1 ('MetaData "DeleteBranchResponse" "Amazonka.CodeCommit.DeleteBranch" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "DeleteBranchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deletedBranch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BranchInfo)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteBranchResponse Source #

Create a value of DeleteBranchResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deletedBranch:DeleteBranchResponse', deleteBranchResponse_deletedBranch - Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.

$sel:httpStatus:DeleteBranchResponse', deleteBranchResponse_httpStatus - The response's http status code.

Response Lenses

deleteBranchResponse_deletedBranch :: Lens' DeleteBranchResponse (Maybe BranchInfo) Source #

Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.