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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

This operation returns paginated results.

Synopsis

data SearchInsights = SearchInsights' {
- filters :: Maybe SearchInsightsFilters
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- startTimeRange :: StartTimeRange
- type' :: InsightType
}
newSearchInsights :: StartTimeRange -> InsightType -> SearchInsights
searchInsights_filters :: Lens' SearchInsights (Maybe SearchInsightsFilters)
searchInsights_maxResults :: Lens' SearchInsights (Maybe Natural)
searchInsights_nextToken :: Lens' SearchInsights (Maybe Text)
searchInsights_startTimeRange :: Lens' SearchInsights StartTimeRange
searchInsights_type :: Lens' SearchInsights InsightType
data SearchInsightsResponse = SearchInsightsResponse' {
- nextToken :: Maybe Text
- proactiveInsights :: Maybe [ProactiveInsightSummary]
- reactiveInsights :: Maybe [ReactiveInsightSummary]
- httpStatus :: Int
}
newSearchInsightsResponse :: Int -> SearchInsightsResponse
searchInsightsResponse_nextToken :: Lens' SearchInsightsResponse (Maybe Text)
searchInsightsResponse_proactiveInsights :: Lens' SearchInsightsResponse (Maybe [ProactiveInsightSummary])
searchInsightsResponse_reactiveInsights :: Lens' SearchInsightsResponse (Maybe [ReactiveInsightSummary])
searchInsightsResponse_httpStatus :: Lens' SearchInsightsResponse Int

Creating a Request

data SearchInsights Source #

See: newSearchInsights smart constructor.

Constructors

SearchInsights'

Fields

filters :: Maybe SearchInsightsFilters
A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.
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.
startTimeRange :: StartTimeRange
The start of the time range passed in. Returned insights occurred after this time.
type' :: InsightType
The type of insights you are searching for (REACTIVE or PROACTIVE).

Instances

Instances details

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

newSearchInsights Source #

Arguments

:: StartTimeRange	`SearchInsights`
-> InsightType	`SearchInsights`
-> SearchInsights

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

SearchInsights, searchInsights_filters - A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.

$sel:maxResults:SearchInsights', searchInsights_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.

SearchInsights, searchInsights_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.

SearchInsights, searchInsights_startTimeRange - The start of the time range passed in. Returned insights occurred after this time.

SearchInsights, searchInsights_type - The type of insights you are searching for (REACTIVE or PROACTIVE).

Request Lenses

searchInsights_filters :: Lens' SearchInsights (Maybe SearchInsightsFilters) Source #

A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.

searchInsights_maxResults :: Lens' SearchInsights (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.

searchInsights_nextToken :: Lens' SearchInsights (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.

searchInsights_startTimeRange :: Lens' SearchInsights StartTimeRange Source #

The start of the time range passed in. Returned insights occurred after this time.

searchInsights_type :: Lens' SearchInsights InsightType Source #

The type of insights you are searching for (REACTIVE or PROACTIVE).

Destructuring the Response

data SearchInsightsResponse Source #

See: newSearchInsightsResponse smart constructor.

Constructors

SearchInsightsResponse'
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. proactiveInsights :: Maybe [ProactiveInsightSummary] The returned proactive insights. reactiveInsights :: Maybe [ReactiveInsightSummary] The returned reactive insights. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSearchInsightsResponse Source #

Arguments

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

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

SearchInsights, searchInsightsResponse_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:proactiveInsights:SearchInsightsResponse', searchInsightsResponse_proactiveInsights - The returned proactive insights.

$sel:reactiveInsights:SearchInsightsResponse', searchInsightsResponse_reactiveInsights - The returned reactive insights.

$sel:httpStatus:SearchInsightsResponse', searchInsightsResponse_httpStatus - The response's http status code.

Response Lenses

searchInsightsResponse_nextToken :: Lens' SearchInsightsResponse (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.

searchInsightsResponse_proactiveInsights :: Lens' SearchInsightsResponse (Maybe [ProactiveInsightSummary]) Source #

The returned proactive insights.

searchInsightsResponse_reactiveInsights :: Lens' SearchInsightsResponse (Maybe [ReactiveInsightSummary]) Source #

The returned reactive insights.

searchInsightsResponse_httpStatus :: Lens' SearchInsightsResponse Int Source #

The response's http status code.