CloudWatch / Client / describe_insight_rules

describe_insight_rules#

CloudWatch.Client.describe_insight_rules(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_insight_rules(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – Include this value, if it was returned by the previous operation, to get the next set of rules.

  • MaxResults (integer) – The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'InsightRules': [
        {
            'Name': 'string',
            'State': 'string',
            'Schema': 'string',
            'Definition': 'string',
            'ManagedRule': True|False
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • InsightRules (list) –

      The rules returned by the operation.

      • (dict) –

        This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide .

        • Name (string) –

          The name of the rule.

        • State (string) –

          Indicates whether the rule is enabled or disabled.

        • Schema (string) –

          For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1} . For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

        • Definition (string) –

          The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.

        • ManagedRule (boolean) –

          An optional built-in rule that Amazon Web Services manages.

Exceptions

  • CloudWatch.Client.exceptions.InvalidNextToken