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.XRay.GetInsightSummaries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Synopsis

data GetInsightSummaries = GetInsightSummaries' {
- groupARN :: Maybe Text
- groupName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- states :: Maybe [InsightState]
- startTime :: POSIX
- endTime :: POSIX
}
newGetInsightSummaries :: UTCTime -> UTCTime -> GetInsightSummaries
getInsightSummaries_groupARN :: Lens' GetInsightSummaries (Maybe Text)
getInsightSummaries_groupName :: Lens' GetInsightSummaries (Maybe Text)
getInsightSummaries_maxResults :: Lens' GetInsightSummaries (Maybe Natural)
getInsightSummaries_nextToken :: Lens' GetInsightSummaries (Maybe Text)
getInsightSummaries_states :: Lens' GetInsightSummaries (Maybe [InsightState])
getInsightSummaries_startTime :: Lens' GetInsightSummaries UTCTime
getInsightSummaries_endTime :: Lens' GetInsightSummaries UTCTime
data GetInsightSummariesResponse = GetInsightSummariesResponse' {
- insightSummaries :: Maybe [InsightSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetInsightSummariesResponse :: Int -> GetInsightSummariesResponse
getInsightSummariesResponse_insightSummaries :: Lens' GetInsightSummariesResponse (Maybe [InsightSummary])
getInsightSummariesResponse_nextToken :: Lens' GetInsightSummariesResponse (Maybe Text)
getInsightSummariesResponse_httpStatus :: Lens' GetInsightSummariesResponse Int

Creating a Request

data GetInsightSummaries Source #

See: newGetInsightSummaries smart constructor.

Constructors

GetInsightSummaries'

Fields

groupARN :: Maybe Text
The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
groupName :: Maybe Text
The name of the group. Required if the GroupARN isn't provided.
maxResults :: Maybe Natural
The maximum number of results to display.
nextToken :: Maybe Text
Pagination token.
states :: Maybe [InsightState]
The list of insight states.
startTime :: POSIX
The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
endTime :: POSIX
The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

Instances

Instances details

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

newGetInsightSummaries Source #

Arguments

:: UTCTime	`GetInsightSummaries`
-> UTCTime	`GetInsightSummaries`
-> GetInsightSummaries

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

GetInsightSummaries, getInsightSummaries_groupARN - The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

GetInsightSummaries, getInsightSummaries_groupName - The name of the group. Required if the GroupARN isn't provided.

$sel:maxResults:GetInsightSummaries', getInsightSummaries_maxResults - The maximum number of results to display.

GetInsightSummaries, getInsightSummaries_nextToken - Pagination token.

$sel:states:GetInsightSummaries', getInsightSummaries_states - The list of insight states.

GetInsightSummaries, getInsightSummaries_startTime - The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

GetInsightSummaries, getInsightSummaries_endTime - The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

Request Lenses

getInsightSummaries_groupARN :: Lens' GetInsightSummaries (Maybe Text) Source #

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

getInsightSummaries_groupName :: Lens' GetInsightSummaries (Maybe Text) Source #

The name of the group. Required if the GroupARN isn't provided.

getInsightSummaries_maxResults :: Lens' GetInsightSummaries (Maybe Natural) Source #

The maximum number of results to display.

getInsightSummaries_nextToken :: Lens' GetInsightSummaries (Maybe Text) Source #

Pagination token.

getInsightSummaries_states :: Lens' GetInsightSummaries (Maybe [InsightState]) Source #

The list of insight states.

getInsightSummaries_startTime :: Lens' GetInsightSummaries UTCTime Source #

The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

getInsightSummaries_endTime :: Lens' GetInsightSummaries UTCTime Source #

The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

Destructuring the Response

data GetInsightSummariesResponse Source #

See: newGetInsightSummariesResponse smart constructor.

Constructors

GetInsightSummariesResponse'

Fields

insightSummaries :: Maybe [InsightSummary]
The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.
nextToken :: Maybe Text
Pagination token.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetInsightSummariesResponse Source #

Arguments

:: Int	`GetInsightSummariesResponse`
-> GetInsightSummariesResponse

Create a value of GetInsightSummariesResponse 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:insightSummaries:GetInsightSummariesResponse', getInsightSummariesResponse_insightSummaries - The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.

GetInsightSummaries, getInsightSummariesResponse_nextToken - Pagination token.

GetInsightSummariesResponse, getInsightSummariesResponse_httpStatus - The response's http status code.

Response Lenses

getInsightSummariesResponse_insightSummaries :: Lens' GetInsightSummariesResponse (Maybe [InsightSummary]) Source #

The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.

getInsightSummariesResponse_nextToken :: Lens' GetInsightSummariesResponse (Maybe Text) Source #

Pagination token.

getInsightSummariesResponse_httpStatus :: Lens' GetInsightSummariesResponse Int Source #

The response's http status code.