cloudtrail_get_insight_selectors: Describes the settings for the Insights event selectors that...

Description Usage Arguments Value Request syntax

View source: R/cloudtrail_operations.R

Description

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

For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.

Usage

1

Arguments

TrailName

[required] 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

Value

A list with the following syntax:

1
2
3
4
5
6
7
8
list(
  TrailARN = "string",
  InsightSelectors = list(
    list(
      InsightType = "ApiCallRateInsight"
    )
  )
)

Request syntax

1
2
3
svc$get_insight_selectors(
  TrailName = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.