[ aws . cloudtrail ]

put-insight-selectors

Description

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event type in this release is ApiCallRateInsight .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-insight-selectors
--trail-name <value>
--insight-selectors <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--trail-name (string)

The name of the CloudTrail trail for which you want to change or add Insights selectors.

--insight-selectors (list)

A JSON string that contains the Insights types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight .

(structure)

A JSON string that contains a list of insight types that are logged on a trail.

InsightType -> (string)

The type of Insights events to log on a trail. The valid Insights type in this release is ApiCallRateInsight .

Shorthand Syntax:

InsightType=string ...

JSON Syntax:

[
  {
    "InsightType": "ApiCallRateInsight"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

TrailARN -> (string)

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

InsightSelectors -> (list)

A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight .

(structure)

A JSON string that contains a list of insight types that are logged on a trail.

InsightType -> (string)

The type of Insights events to log on a trail. The valid Insights type in this release is ApiCallRateInsight .