Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns information about one or more pull request events.
This operation returns paginated results.
Synopsis
- describePullRequestEvents :: Text -> DescribePullRequestEvents
- data DescribePullRequestEvents
- dprePullRequestEventType :: Lens' DescribePullRequestEvents (Maybe PullRequestEventType)
- dpreActorARN :: Lens' DescribePullRequestEvents (Maybe Text)
- dpreNextToken :: Lens' DescribePullRequestEvents (Maybe Text)
- dpreMaxResults :: Lens' DescribePullRequestEvents (Maybe Int)
- dprePullRequestId :: Lens' DescribePullRequestEvents Text
- describePullRequestEventsResponse :: Int -> DescribePullRequestEventsResponse
- data DescribePullRequestEventsResponse
- dprersNextToken :: Lens' DescribePullRequestEventsResponse (Maybe Text)
- dprersResponseStatus :: Lens' DescribePullRequestEventsResponse Int
- dprersPullRequestEvents :: Lens' DescribePullRequestEventsResponse [PullRequestEvent]
Creating a Request
describePullRequestEvents Source #
Creates a value of DescribePullRequestEvents
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dprePullRequestEventType
- Optional. The pull request event type about which you want to return information.dpreActorARN
- The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.dpreNextToken
- An enumeration token that when provided in a request, returns the next batch of the results.dpreMaxResults
- A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.dprePullRequestId
- The system-generated ID of the pull request. To get this ID, useListPullRequests
.
data DescribePullRequestEvents Source #
See: describePullRequestEvents
smart constructor.
Instances
Request Lenses
dprePullRequestEventType :: Lens' DescribePullRequestEvents (Maybe PullRequestEventType) Source #
Optional. The pull request event type about which you want to return information.
dpreActorARN :: Lens' DescribePullRequestEvents (Maybe Text) Source #
The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.
dpreNextToken :: Lens' DescribePullRequestEvents (Maybe Text) Source #
An enumeration token that when provided in a request, returns the next batch of the results.
dpreMaxResults :: Lens' DescribePullRequestEvents (Maybe Int) Source #
A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.
dprePullRequestId :: Lens' DescribePullRequestEvents Text Source #
The system-generated ID of the pull request. To get this ID, use ListPullRequests
.
Destructuring the Response
describePullRequestEventsResponse Source #
Creates a value of DescribePullRequestEventsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dprersNextToken
- An enumeration token that can be used in a request to return the next batch of the results.dprersResponseStatus
- -- | The response status code.dprersPullRequestEvents
- Information about the pull request events.
data DescribePullRequestEventsResponse Source #
See: describePullRequestEventsResponse
smart constructor.
Instances
Response Lenses
dprersNextToken :: Lens' DescribePullRequestEventsResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
dprersResponseStatus :: Lens' DescribePullRequestEventsResponse Int Source #
- - | The response status code.
dprersPullRequestEvents :: Lens' DescribePullRequestEventsResponse [PullRequestEvent] Source #
Information about the pull request events.