Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeCommit.ListBranches

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about one or more branches in a repository.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBranches Source #

Represents the input of a list branches operation.

See: newListBranches smart constructor.

Constructors

ListBranches'
Fields nextToken :: Maybe Text An enumeration token that allows the operation to batch the results. repositoryName :: Text The name of the repository that contains the branches.

Instances

Instances details

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

newListBranches Source #

Arguments

:: Text	`ListBranches`
-> ListBranches

Create a value of ListBranches 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:

ListBranches, listBranches_nextToken - An enumeration token that allows the operation to batch the results.

ListBranches, listBranches_repositoryName - The name of the repository that contains the branches.

Request Lenses

listBranches_nextToken :: Lens' ListBranches (Maybe Text) Source #

An enumeration token that allows the operation to batch the results.

listBranches_repositoryName :: Lens' ListBranches Text Source #

The name of the repository that contains the branches.

Destructuring the Response

data ListBranchesResponse Source #

Represents the output of a list branches operation.

See: newListBranchesResponse smart constructor.

Constructors

ListBranchesResponse'
Fields branches :: Maybe [Text] The list of branch names. nextToken :: Maybe Text An enumeration token that returns the batch of the results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches Associated Types type Rep ListBranchesResponse :: Type -> Type # Methods from :: ListBranchesResponse -> Rep ListBranchesResponse x # to :: Rep ListBranchesResponse x -> ListBranchesResponse #
Read ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches Methods readsPrec :: Int -> ReadS ListBranchesResponse # readList :: ReadS [ListBranchesResponse] # readPrec :: ReadPrec ListBranchesResponse # readListPrec :: ReadPrec [ListBranchesResponse] #
Show ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches Methods showsPrec :: Int -> ListBranchesResponse -> ShowS # show :: ListBranchesResponse -> String # showList :: [ListBranchesResponse] -> ShowS #
NFData ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches Methods rnf :: ListBranchesResponse -> () #
Eq ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches Methods (==) :: ListBranchesResponse -> ListBranchesResponse -> Bool # (/=) :: ListBranchesResponse -> ListBranchesResponse -> Bool #
type Rep ListBranchesResponse Source #
Instance details Defined in Amazonka.CodeCommit.ListBranches type Rep ListBranchesResponse = D1 ('MetaData "ListBranchesResponse" "Amazonka.CodeCommit.ListBranches" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "ListBranchesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBranchesResponse Source #

Arguments

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

Create a value of ListBranchesResponse 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:

ListBranchesResponse, listBranchesResponse_branches - The list of branch names.

ListBranches, listBranchesResponse_nextToken - An enumeration token that returns the batch of the results.

$sel:httpStatus:ListBranchesResponse', listBranchesResponse_httpStatus - The response's http status code.

Response Lenses

listBranchesResponse_branches :: Lens' ListBranchesResponse (Maybe [Text]) Source #

The list of branch names.

listBranchesResponse_nextToken :: Lens' ListBranchesResponse (Maybe Text) Source #

An enumeration token that returns the batch of the results.

listBranchesResponse_httpStatus :: Lens' ListBranchesResponse Int Source #

The response's http status code.