| 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.DescribePullRequestEvents
Description
Returns information about one or more pull request events.
This operation returns paginated results.
Synopsis
- data DescribePullRequestEvents = DescribePullRequestEvents' {}
- newDescribePullRequestEvents :: Text -> DescribePullRequestEvents
- describePullRequestEvents_pullRequestEventType :: Lens' DescribePullRequestEvents (Maybe PullRequestEventType)
- describePullRequestEvents_actorArn :: Lens' DescribePullRequestEvents (Maybe Text)
- describePullRequestEvents_nextToken :: Lens' DescribePullRequestEvents (Maybe Text)
- describePullRequestEvents_maxResults :: Lens' DescribePullRequestEvents (Maybe Int)
- describePullRequestEvents_pullRequestId :: Lens' DescribePullRequestEvents Text
- data DescribePullRequestEventsResponse = DescribePullRequestEventsResponse' {}
- newDescribePullRequestEventsResponse :: Int -> DescribePullRequestEventsResponse
- describePullRequestEventsResponse_nextToken :: Lens' DescribePullRequestEventsResponse (Maybe Text)
- describePullRequestEventsResponse_httpStatus :: Lens' DescribePullRequestEventsResponse Int
- describePullRequestEventsResponse_pullRequestEvents :: Lens' DescribePullRequestEventsResponse [PullRequestEvent]
Creating a Request
data DescribePullRequestEvents Source #
See: newDescribePullRequestEvents smart constructor.
Constructors
| DescribePullRequestEvents' | |
Fields
| |
Instances
newDescribePullRequestEvents Source #
Create a value of DescribePullRequestEvents 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:pullRequestEventType:DescribePullRequestEvents', describePullRequestEvents_pullRequestEventType - Optional. The pull request event type about which you want to return
information.
$sel:actorArn:DescribePullRequestEvents', describePullRequestEvents_actorArn - The Amazon Resource Name (ARN) of the user whose actions resulted in the
event. Examples include updating the pull request with more commits or
changing the status of a pull request.
$sel:nextToken:DescribePullRequestEvents', describePullRequestEvents_nextToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
$sel:maxResults:DescribePullRequestEvents', describePullRequestEvents_maxResults - A non-zero, 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.
$sel:pullRequestId:DescribePullRequestEvents', describePullRequestEvents_pullRequestId - The system-generated ID of the pull request. To get this ID, use
ListPullRequests.
Request Lenses
describePullRequestEvents_pullRequestEventType :: Lens' DescribePullRequestEvents (Maybe PullRequestEventType) Source #
Optional. The pull request event type about which you want to return information.
describePullRequestEvents_actorArn :: 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 more commits or changing the status of a pull request.
describePullRequestEvents_nextToken :: Lens' DescribePullRequestEvents (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
describePullRequestEvents_maxResults :: Lens' DescribePullRequestEvents (Maybe Int) Source #
A non-zero, 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.
describePullRequestEvents_pullRequestId :: Lens' DescribePullRequestEvents Text Source #
The system-generated ID of the pull request. To get this ID, use ListPullRequests.
Destructuring the Response
data DescribePullRequestEventsResponse Source #
See: newDescribePullRequestEventsResponse smart constructor.
Constructors
| DescribePullRequestEventsResponse' | |
Fields
| |
Instances
newDescribePullRequestEventsResponse Source #
Arguments
| :: Int | |
| -> DescribePullRequestEventsResponse |
Create a value of DescribePullRequestEventsResponse 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:nextToken:DescribePullRequestEvents', describePullRequestEventsResponse_nextToken - An enumeration token that can be used in a request to return the next
batch of the results.
$sel:httpStatus:DescribePullRequestEventsResponse', describePullRequestEventsResponse_httpStatus - The response's http status code.
$sel:pullRequestEvents:DescribePullRequestEventsResponse', describePullRequestEventsResponse_pullRequestEvents - Information about the pull request events.
Response Lenses
describePullRequestEventsResponse_nextToken :: Lens' DescribePullRequestEventsResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
describePullRequestEventsResponse_httpStatus :: Lens' DescribePullRequestEventsResponse Int Source #
The response's http status code.
describePullRequestEventsResponse_pullRequestEvents :: Lens' DescribePullRequestEventsResponse [PullRequestEvent] Source #
Information about the pull request events.