CloudTrail / Client / get_insight_selectors

get_insight_selectors#

CloudTrail.Client.get_insight_selectors(**kwargs)#

Describes the settings for the Insights event selectors that you configured for your trail or event data store. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

Specify either the EventDataStore parameter to get Insights event selectors for an event data store, or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.

For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_insight_selectors(
    TrailName='string',
    EventDataStore='string'
)
Parameters:

  • TrailName (string) –

    Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

    • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

    • Start with a letter or number, and end with a letter or number

    • Be between 3 and 128 characters

    • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

    • Not be in IP address format (for example, 192.168.5.4)

    If you specify a trail ARN, it must be in the format:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

    You cannot use this parameter with the EventDataStore parameter.

  • EventDataStore (string) –

    Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors.

    You cannot use this parameter with the TrailName parameter.

Return type:

dict

Returns:

Response Syntax

{
    'TrailARN': 'string',
    'InsightSelectors': [
        {
            'InsightType': 'ApiCallRateInsight'|'ApiErrorRateInsight'
        },
    ],
    'EventDataStoreArn': 'string',
    'InsightsDestination': 'string'
}

Response Structure

  • (dict) –

    • TrailARN (string) –

      The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

    • InsightSelectors (list) –

      A JSON string that contains the Insight types you want to log on a trail or event data store. ApiErrorRateInsight and ApiCallRateInsight are supported as Insights types.

      • (dict) –

        A JSON string that contains a list of Insights types that are logged on a trail or event data store.

        • InsightType (string) –

          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 that are aggregated per minute against a baseline API call volume.

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

    • EventDataStoreArn (string) –

      The ARN of the source event data store that enabled Insights events.

    • InsightsDestination (string) –

      The ARN of the destination event data store that logs Insights events.

Exceptions