Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 types in this release are ApiErrorRateInsight and 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 <value>]
[--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 insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

(structure)

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

InsightType -> (string)

The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

Shorthand Syntax:

InsightType=string ...

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 types in this release are ApiErrorRateInsight and ApiCallRateInsight .

(structure)

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

InsightType -> (string)

The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.