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 |
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' {}
- 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' {}
- 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.
SearchInsights' | |
|
Instances
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.
SearchInsightsResponse' | |
|
Instances
newSearchInsightsResponse Source #
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.