Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeInsightRules

Returns a list of all the Contributor Insights rules in your account.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Include this value, if it was returned by the previous operation, to get the next set of rules.

Type: String

Required: No

Response Syntax


{
   "InsightRules": [ 
      { 
         "ApplyOnTransformedLogs": boolean,
         "Definition": "string",
         "ManagedRule": boolean,
         "Name": "string",
         "Schema": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InsightRules

The rules returned by the operation.

Type: Array of InsightRule objects

NextToken

If this parameter is present, it is a token that marks the start of the next batch of returned results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidNextToken

The next token specified is invalid.

message

HTTP Status Code: 400