CloudWatch / Client / put_insight_rule

put_insight_rule#

CloudWatch.Client.put_insight_rule(**kwargs)#

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See also: AWS API Documentation

Request Syntax

response = client.put_insight_rule(
    RuleName='string',
    RuleState='string',
    RuleDefinition='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • RuleName (string) –

    [REQUIRED]

    A unique name for the rule.

  • RuleState (string) – The state of the rule. Valid values are ENABLED and DISABLED.

  • RuleDefinition (string) –

    [REQUIRED]

    The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

  • Tags (list) –

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

    • (dict) –

      A key-value pair associated with a CloudWatch resource.

      • Key (string) – [REQUIRED]

        A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value (string) – [REQUIRED]

        The value for the specified tag key.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CloudWatch.Client.exceptions.InvalidParameterValueException

  • CloudWatch.Client.exceptions.MissingRequiredParameterException

  • CloudWatch.Client.exceptions.LimitExceededException