Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeCommit.DeleteBranch

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DeleteBranch Source #

Represents the input of a delete branch operation.

See: newDeleteBranch smart constructor.

Constructors

DeleteBranch'
Fields repositoryName :: Text The name of the repository that contains the branch to be deleted. branchName :: Text The name of the branch to delete.

Instances

Instances details

Eq DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods (==) :: DeleteBranch -> DeleteBranch -> Bool # (/=) :: DeleteBranch -> DeleteBranch -> Bool #
Read DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods readsPrec :: Int -> ReadS DeleteBranch # readList :: ReadS [DeleteBranch] # readPrec :: ReadPrec DeleteBranch # readListPrec :: ReadPrec [DeleteBranch] #
Show DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods showsPrec :: Int -> DeleteBranch -> ShowS # show :: DeleteBranch -> String # showList :: [DeleteBranch] -> ShowS #
Generic DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Associated Types type Rep DeleteBranch :: Type -> Type # Methods from :: DeleteBranch -> Rep DeleteBranch x # to :: Rep DeleteBranch x -> DeleteBranch #
NFData DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods rnf :: DeleteBranch -> () #
Hashable DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods hashWithSalt :: Int -> DeleteBranch -> Int # hash :: DeleteBranch -> Int #
ToJSON DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods toJSON :: DeleteBranch -> Value # toEncoding :: DeleteBranch -> Encoding # toJSONList :: [DeleteBranch] -> Value # toEncodingList :: [DeleteBranch] -> Encoding #
AWSRequest DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Associated Types type AWSResponse DeleteBranch # Methods request :: DeleteBranch -> Request DeleteBranch # response :: MonadResource m => Logger -> Service -> Proxy DeleteBranch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteBranch))) #
ToHeaders DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods toHeaders :: DeleteBranch -> [Header] #
ToPath DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods toPath :: DeleteBranch -> ByteString #
ToQuery DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods toQuery :: DeleteBranch -> QueryString #
type Rep DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch type Rep DeleteBranch = D1 ('MetaData "DeleteBranch" "Amazonka.CodeCommit.DeleteBranch" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "DeleteBranch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteBranch Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch type AWSResponse DeleteBranch = DeleteBranchResponse

newDeleteBranch Source #

Arguments

:: Text	`$sel:repositoryName:DeleteBranch'`
-> Text	`$sel:branchName:DeleteBranch'`
-> DeleteBranch

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:

$sel:repositoryName:DeleteBranch', deleteBranch_repositoryName - The name of the repository that contains the branch to be deleted.

$sel:branchName: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

Eq DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods (==) :: DeleteBranchResponse -> DeleteBranchResponse -> Bool # (/=) :: DeleteBranchResponse -> DeleteBranchResponse -> Bool #
Read DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods readsPrec :: Int -> ReadS DeleteBranchResponse # readList :: ReadS [DeleteBranchResponse] # readPrec :: ReadPrec DeleteBranchResponse # readListPrec :: ReadPrec [DeleteBranchResponse] #
Show DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods showsPrec :: Int -> DeleteBranchResponse -> ShowS # show :: DeleteBranchResponse -> String # showList :: [DeleteBranchResponse] -> ShowS #
Generic DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Associated Types type Rep DeleteBranchResponse :: Type -> Type # Methods from :: DeleteBranchResponse -> Rep DeleteBranchResponse x # to :: Rep DeleteBranchResponse x -> DeleteBranchResponse #
NFData DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch Methods rnf :: DeleteBranchResponse -> () #
type Rep DeleteBranchResponse Source #
Instance details Defined in Amazonka.CodeCommit.DeleteBranch type Rep DeleteBranchResponse = D1 ('MetaData "DeleteBranchResponse" "Amazonka.CodeCommit.DeleteBranch" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" '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 #

Arguments

:: Int	`$sel:httpStatus:DeleteBranchResponse'`
-> DeleteBranchResponse

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.

deleteBranchResponse_httpStatus :: Lens' DeleteBranchResponse Int Source #

The response's http status code.