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 organization. You can specify which
insights are returned by their start time, one or more statuses
(ONGOING
, CLOSED
, and 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 SearchOrganizationInsights = SearchOrganizationInsights' {}
- newSearchOrganizationInsights :: NonEmpty Text -> StartTimeRange -> InsightType -> SearchOrganizationInsights
- searchOrganizationInsights_filters :: Lens' SearchOrganizationInsights (Maybe SearchOrganizationInsightsFilters)
- searchOrganizationInsights_maxResults :: Lens' SearchOrganizationInsights (Maybe Natural)
- searchOrganizationInsights_nextToken :: Lens' SearchOrganizationInsights (Maybe Text)
- searchOrganizationInsights_accountIds :: Lens' SearchOrganizationInsights (NonEmpty Text)
- searchOrganizationInsights_startTimeRange :: Lens' SearchOrganizationInsights StartTimeRange
- searchOrganizationInsights_type :: Lens' SearchOrganizationInsights InsightType
- data SearchOrganizationInsightsResponse = SearchOrganizationInsightsResponse' {}
- newSearchOrganizationInsightsResponse :: Int -> SearchOrganizationInsightsResponse
- searchOrganizationInsightsResponse_nextToken :: Lens' SearchOrganizationInsightsResponse (Maybe Text)
- searchOrganizationInsightsResponse_proactiveInsights :: Lens' SearchOrganizationInsightsResponse (Maybe [ProactiveInsightSummary])
- searchOrganizationInsightsResponse_reactiveInsights :: Lens' SearchOrganizationInsightsResponse (Maybe [ReactiveInsightSummary])
- searchOrganizationInsightsResponse_httpStatus :: Lens' SearchOrganizationInsightsResponse Int
Creating a Request
data SearchOrganizationInsights Source #
See: newSearchOrganizationInsights
smart constructor.
SearchOrganizationInsights' | |
|
Instances
newSearchOrganizationInsights Source #
Create a value of SearchOrganizationInsights
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:
SearchOrganizationInsights
, searchOrganizationInsights_filters
- A SearchOrganizationInsightsFilters
object that is used to set the
severity and status filters on your insight search.
$sel:maxResults:SearchOrganizationInsights'
, searchOrganizationInsights_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.
SearchOrganizationInsights
, searchOrganizationInsights_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.
$sel:accountIds:SearchOrganizationInsights'
, searchOrganizationInsights_accountIds
- The ID of the Amazon Web Services account.
SearchOrganizationInsights
, searchOrganizationInsights_startTimeRange
- Undocumented member.
SearchOrganizationInsights
, searchOrganizationInsights_type
- The type of insights you are searching for (REACTIVE
or PROACTIVE
).
Request Lenses
searchOrganizationInsights_filters :: Lens' SearchOrganizationInsights (Maybe SearchOrganizationInsightsFilters) Source #
A SearchOrganizationInsightsFilters
object that is used to set the
severity and status filters on your insight search.
searchOrganizationInsights_maxResults :: Lens' SearchOrganizationInsights (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.
searchOrganizationInsights_nextToken :: Lens' SearchOrganizationInsights (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.
searchOrganizationInsights_accountIds :: Lens' SearchOrganizationInsights (NonEmpty Text) Source #
The ID of the Amazon Web Services account.
searchOrganizationInsights_startTimeRange :: Lens' SearchOrganizationInsights StartTimeRange Source #
Undocumented member.
searchOrganizationInsights_type :: Lens' SearchOrganizationInsights InsightType Source #
The type of insights you are searching for (REACTIVE
or PROACTIVE
).
Destructuring the Response
data SearchOrganizationInsightsResponse Source #
See: newSearchOrganizationInsightsResponse
smart constructor.
SearchOrganizationInsightsResponse' | |
|
Instances
newSearchOrganizationInsightsResponse Source #
Create a value of SearchOrganizationInsightsResponse
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:
SearchOrganizationInsights
, searchOrganizationInsightsResponse_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:SearchOrganizationInsightsResponse'
, searchOrganizationInsightsResponse_proactiveInsights
- An integer that specifies the number of open proactive insights in your
Amazon Web Services account.
$sel:reactiveInsights:SearchOrganizationInsightsResponse'
, searchOrganizationInsightsResponse_reactiveInsights
- An integer that specifies the number of open reactive insights in your
Amazon Web Services account.
$sel:httpStatus:SearchOrganizationInsightsResponse'
, searchOrganizationInsightsResponse_httpStatus
- The response's http status code.
Response Lenses
searchOrganizationInsightsResponse_nextToken :: Lens' SearchOrganizationInsightsResponse (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.
searchOrganizationInsightsResponse_proactiveInsights :: Lens' SearchOrganizationInsightsResponse (Maybe [ProactiveInsightSummary]) Source #
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
searchOrganizationInsightsResponse_reactiveInsights :: Lens' SearchOrganizationInsightsResponse (Maybe [ReactiveInsightSummary]) Source #
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
searchOrganizationInsightsResponse_httpStatus :: Lens' SearchOrganizationInsightsResponse Int Source #
The response's http status code.