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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.

This operation returns paginated results.

Synopsis

data ListPullRequests = ListPullRequests' {
- authorArn :: Maybe Text
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- pullRequestStatus :: Maybe PullRequestStatusEnum
- repositoryName :: Text
}
newListPullRequests :: Text -> ListPullRequests
listPullRequests_authorArn :: Lens' ListPullRequests (Maybe Text)
listPullRequests_maxResults :: Lens' ListPullRequests (Maybe Int)
listPullRequests_nextToken :: Lens' ListPullRequests (Maybe Text)
listPullRequests_pullRequestStatus :: Lens' ListPullRequests (Maybe PullRequestStatusEnum)
listPullRequests_repositoryName :: Lens' ListPullRequests Text
data ListPullRequestsResponse = ListPullRequestsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- pullRequestIds :: [Text]
}
newListPullRequestsResponse :: Int -> ListPullRequestsResponse
listPullRequestsResponse_nextToken :: Lens' ListPullRequestsResponse (Maybe Text)
listPullRequestsResponse_httpStatus :: Lens' ListPullRequestsResponse Int
listPullRequestsResponse_pullRequestIds :: Lens' ListPullRequestsResponse [Text]

Creating a Request

data ListPullRequests Source #

See: newListPullRequests smart constructor.

Constructors

ListPullRequests'

Fields

authorArn :: Maybe Text
Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.
maxResults :: Maybe Int
A non-zero, non-negative integer used to limit the number of returned results.
nextToken :: Maybe Text
An enumeration token that, when provided in a request, returns the next batch of the results.
pullRequestStatus :: Maybe PullRequestStatusEnum
Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.
repositoryName :: Text
The name of the repository for which you want to list pull requests.

Instances

Instances details

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

newListPullRequests Source #

Arguments

:: Text	`ListPullRequests`
-> ListPullRequests

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

ListPullRequests, listPullRequests_authorArn - Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.

$sel:maxResults:ListPullRequests', listPullRequests_maxResults - A non-zero, non-negative integer used to limit the number of returned results.

ListPullRequests, listPullRequests_nextToken - An enumeration token that, when provided in a request, returns the next batch of the results.

ListPullRequests, listPullRequests_pullRequestStatus - Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.

ListPullRequests, listPullRequests_repositoryName - The name of the repository for which you want to list pull requests.

Request Lenses

listPullRequests_authorArn :: Lens' ListPullRequests (Maybe Text) Source #

Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.

listPullRequests_maxResults :: Lens' ListPullRequests (Maybe Int) Source #

A non-zero, non-negative integer used to limit the number of returned results.

listPullRequests_nextToken :: Lens' ListPullRequests (Maybe Text) Source #

An enumeration token that, when provided in a request, returns the next batch of the results.

listPullRequests_pullRequestStatus :: Lens' ListPullRequests (Maybe PullRequestStatusEnum) Source #

Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.

listPullRequests_repositoryName :: Lens' ListPullRequests Text Source #

The name of the repository for which you want to list pull requests.

Destructuring the Response

data ListPullRequestsResponse Source #

See: newListPullRequestsResponse smart constructor.

Constructors

ListPullRequestsResponse'
Fields nextToken :: Maybe Text An enumeration token that allows the operation to batch the next results of the operation. httpStatus :: Int The response's http status code. pullRequestIds :: [Text] The system-generated IDs of the pull requests.

Instances

Instances details

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

newListPullRequestsResponse Source #

Arguments

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

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

ListPullRequests, listPullRequestsResponse_nextToken - An enumeration token that allows the operation to batch the next results of the operation.

$sel:httpStatus:ListPullRequestsResponse', listPullRequestsResponse_httpStatus - The response's http status code.

$sel:pullRequestIds:ListPullRequestsResponse', listPullRequestsResponse_pullRequestIds - The system-generated IDs of the pull requests.

Response Lenses

listPullRequestsResponse_nextToken :: Lens' ListPullRequestsResponse (Maybe Text) Source #

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

listPullRequestsResponse_httpStatus :: Lens' ListPullRequestsResponse Int Source #

The response's http status code.

listPullRequestsResponse_pullRequestIds :: Lens' ListPullRequestsResponse [Text] Source #

The system-generated IDs of the pull requests.