Skip to content

InsightSelector

Source code in docs_src/capo_cloudtrail/types/insight_selector.py 
12
13
14
15
16
17
18
class InsightSelector(TypedDict, closed=True):
    insight_type: NotRequired["capo_cloudtrail.types.insight_type.InsightType"]
    """<p>The type of Insights events to log on a trail or event data store. <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid Insight types.</p> <p>The <code>ApiCallRateInsight</code> Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.</p> <p>The <code>ApiErrorRateInsight</code> Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.</p>"""
    event_categories: NotRequired[
        "capo_cloudtrail.types.source_event_categories.SourceEventCategories"
    ]
    """<p>Select the event category on which Insights should be enabled. </p> <ul> <li> <p>If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.</p> </li> <li> <p>If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled. </p> </li> </ul>"""

event_categories instance-attribute 

event_categories: NotRequired[SourceEventCategories]

Select the event category on which Insights should be enabled.

  • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

  • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

insight_type instance-attribute 

insight_type: NotRequired[InsightType]

The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.