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.DevOpsGuru.ListEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEvents Source #

See: newListEvents smart constructor.

Constructors

ListEvents'

Fields

accountId :: Maybe Text
The ID of the Amazon Web Services account.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
filters :: ListEventsFilters
A ListEventsFilters object used to specify which events to return.

Instances

Instances details

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

newListEvents Source #

Arguments

:: ListEventsFilters	`ListEvents`
-> ListEvents

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

ListEvents, listEvents_accountId - The ID of the Amazon Web Services account.

$sel:maxResults:ListEvents', listEvents_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

ListEvents, listEvents_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

ListEvents, listEvents_filters - A ListEventsFilters object used to specify which events to return.

Request Lenses

listEvents_accountId :: Lens' ListEvents (Maybe Text) Source #

The ID of the Amazon Web Services account.

listEvents_maxResults :: Lens' ListEvents (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listEvents_nextToken :: Lens' ListEvents (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

listEvents_filters :: Lens' ListEvents ListEventsFilters Source #

A ListEventsFilters object used to specify which events to return.

Destructuring the Response

data ListEventsResponse Source #

See: newListEventsResponse smart constructor.

Constructors

ListEventsResponse'
Fields nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. httpStatus :: Int The response's http status code. events :: [Event] A list of the requested events.

Instances

Instances details

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

newListEventsResponse Source #

Arguments

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

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

ListEvents, listEventsResponse_nextToken - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:httpStatus:ListEventsResponse', listEventsResponse_httpStatus - The response's http status code.

$sel:events:ListEventsResponse', listEventsResponse_events - A list of the requested events.

Response Lenses

listEventsResponse_nextToken :: Lens' ListEventsResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

listEventsResponse_httpStatus :: Lens' ListEventsResponse Int Source #

The response's http status code.

listEventsResponse_events :: Lens' ListEventsResponse [Event] Source #

A list of the requested events.