amazonka-xray-2.0: Amazon X-Ray SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.XRay.GetInsightEvents

Description

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Synopsis

Creating a Request

data GetInsightEvents Source #

See: newGetInsightEvents smart constructor.

Constructors

GetInsightEvents' 

Fields

  • maxResults :: Maybe Natural

    Used to retrieve at most the specified value of events.

  • nextToken :: Maybe Text

    Specify the pagination token returned by a previous request to retrieve the next page of events.

  • insightId :: Text

    The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Instances

Instances details
ToJSON GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

toJSON :: GetInsightEvents -> Value #

toEncoding :: GetInsightEvents -> Encoding #

toJSONList :: [GetInsightEvents] -> Value #

toEncodingList :: [GetInsightEvents] -> Encoding #

ToHeaders GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

toHeaders :: GetInsightEvents -> [Header] #

ToPath GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

toPath :: GetInsightEvents -> ByteString #

ToQuery GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

toQuery :: GetInsightEvents -> QueryString #

AWSRequest GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Associated Types

type AWSResponse GetInsightEvents #

Methods

request :: (Service -> Service) -> GetInsightEvents -> Request GetInsightEvents #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetInsightEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInsightEvents))) #

Generic GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Associated Types

type Rep GetInsightEvents :: Type -> Type #

Methods

from :: GetInsightEvents -> Rep GetInsightEvents x #

to :: Rep GetInsightEvents x -> GetInsightEvents #

Read GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

readsPrec :: Int -> ReadS GetInsightEvents #

readList :: ReadS [GetInsightEvents] #

readPrec :: ReadPrec GetInsightEvents #

readListPrec :: ReadPrec [GetInsightEvents] #

Show GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

showsPrec :: Int -> GetInsightEvents -> ShowS #

show :: GetInsightEvents -> String #

showList :: [GetInsightEvents] -> ShowS #

NFData GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

rnf :: GetInsightEvents -> () #

Eq GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

(==) :: GetInsightEvents -> GetInsightEvents -> Bool #

(/=) :: GetInsightEvents -> GetInsightEvents -> Bool #

Hashable GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

hashWithSalt :: Int -> GetInsightEvents -> Int #

hash :: GetInsightEvents -> Int #

type AWSResponse GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

type AWSResponse GetInsightEvents = GetInsightEventsResponse
type Rep GetInsightEvents Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

type Rep GetInsightEvents = D1 ('MetaData "GetInsightEvents" "Amazonka.XRay.GetInsightEvents" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetInsightEvents'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetInsightEvents Source #

Arguments

:: Text

GetInsightEvents

-> GetInsightEvents 

Create a value of GetInsightEvents 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:maxResults:GetInsightEvents', getInsightEvents_maxResults - Used to retrieve at most the specified value of events.

GetInsightEvents, getInsightEvents_nextToken - Specify the pagination token returned by a previous request to retrieve the next page of events.

GetInsightEvents, getInsightEvents_insightId - The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Request Lenses

getInsightEvents_maxResults :: Lens' GetInsightEvents (Maybe Natural) Source #

Used to retrieve at most the specified value of events.

getInsightEvents_nextToken :: Lens' GetInsightEvents (Maybe Text) Source #

Specify the pagination token returned by a previous request to retrieve the next page of events.

getInsightEvents_insightId :: Lens' GetInsightEvents Text Source #

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Destructuring the Response

data GetInsightEventsResponse Source #

See: newGetInsightEventsResponse smart constructor.

Constructors

GetInsightEventsResponse' 

Fields

  • insightEvents :: Maybe [InsightEvent]

    A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

  • nextToken :: Maybe Text

    Use this token to retrieve the next page of insight events.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Associated Types

type Rep GetInsightEventsResponse :: Type -> Type #

Methods

from :: GetInsightEventsResponse -> Rep GetInsightEventsResponse x #

to :: Rep GetInsightEventsResponse x -> GetInsightEventsResponse #

Read GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

readsPrec :: Int -> ReadS GetInsightEventsResponse #

readList :: ReadS [GetInsightEventsResponse] #

readPrec :: ReadPrec GetInsightEventsResponse #

readListPrec :: ReadPrec [GetInsightEventsResponse] #

Show GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

showsPrec :: Int -> GetInsightEventsResponse -> ShowS #

show :: GetInsightEventsResponse -> String #

showList :: [GetInsightEventsResponse] -> ShowS #

NFData GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

rnf :: GetInsightEventsResponse -> () #

Eq GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

Methods

(==) :: GetInsightEventsResponse -> GetInsightEventsResponse -> Bool #

(/=) :: GetInsightEventsResponse -> GetInsightEventsResponse -> Bool #

type Rep GetInsightEventsResponse Source # 
Instance details

Defined in Amazonka.XRay.GetInsightEvents

type Rep GetInsightEventsResponse = D1 ('MetaData "GetInsightEventsResponse" "Amazonka.XRay.GetInsightEvents" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetInsightEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "insightEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InsightEvent])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInsightEventsResponse Source #

Arguments

:: Int

GetInsightEventsResponse

-> GetInsightEventsResponse 

Create a value of GetInsightEventsResponse 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:insightEvents:GetInsightEventsResponse', getInsightEventsResponse_insightEvents - A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

GetInsightEvents, getInsightEventsResponse_nextToken - Use this token to retrieve the next page of insight events.

GetInsightEventsResponse, getInsightEventsResponse_httpStatus - The response's http status code.

Response Lenses

getInsightEventsResponse_insightEvents :: Lens' GetInsightEventsResponse (Maybe [InsightEvent]) Source #

A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

getInsightEventsResponse_nextToken :: Lens' GetInsightEventsResponse (Maybe Text) Source #

Use this token to retrieve the next page of insight events.

getInsightEventsResponse_httpStatus :: Lens' GetInsightEventsResponse Int Source #

The response's http status code.