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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about one or more pull request events.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePullRequestEvents Source #

See: newDescribePullRequestEvents smart constructor.

Constructors

DescribePullRequestEvents'

Fields

actorArn :: Maybe Text
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.
maxResults :: Maybe Int
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.
nextToken :: Maybe Text
An enumeration token that, when provided in a request, returns the next batch of the results.
pullRequestEventType :: Maybe PullRequestEventType
Optional. The pull request event type about which you want to return information.
pullRequestId :: Text
The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Instances

Instances details

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

newDescribePullRequestEvents Source #

Arguments

:: Text	`DescribePullRequestEvents`
-> DescribePullRequestEvents

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:

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

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

DescribePullRequestEvents, describePullRequestEvents_pullRequestEventType - Optional. The pull request event type about which you want to return information.

DescribePullRequestEvents, describePullRequestEvents_pullRequestId - The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Request Lenses

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_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_nextToken :: Lens' DescribePullRequestEvents (Maybe Text) Source #

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

describePullRequestEvents_pullRequestEventType :: Lens' DescribePullRequestEvents (Maybe PullRequestEventType) Source #

Optional. The pull request event type about which you want to return information.

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 nextToken :: Maybe Text An enumeration token that can be used in a request to return the next batch of the results. httpStatus :: Int The response's http status code. pullRequestEvents :: [PullRequestEvent] Information about the pull request events.

Instances

Instances details

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

newDescribePullRequestEventsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePullRequestEventsResponse'`
-> 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:

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.