Get Insight Selectors
cloudtrail_get_insight_selectors | R Documentation |
Describes the settings for the Insights event selectors that you configured for your trail or event data store¶
Description¶
Describes the settings for the Insights event selectors that you
configured for your trail or event data store. get_insight_selectors
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 get_insight_selectors
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.
Usage¶
Arguments¶
TrailName
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
andmy--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
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.
Value¶
A list with the following syntax:
list(
TrailARN = "string",
InsightSelectors = list(
list(
InsightType = "ApiCallRateInsight"|"ApiErrorRateInsight"
)
),
EventDataStoreArn = "string",
InsightsDestination = "string"
)