CloudWatch / Client / put_managed_insight_rules

put_managed_insight_rules#

CloudWatch.Client.put_managed_insight_rules(**kwargs)#

Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use ListManagedInsightRules to describe all available rules.

See also: AWS API Documentation

Request Syntax

response = client.put_managed_insight_rules(
    ManagedRules=[
        {
            'TemplateName': 'string',
            'ResourceARN': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)
Parameters:

ManagedRules (list) –

[REQUIRED]

A list of ManagedRules to enable.

  • (dict) –

    Contains the information that’s required to enable a managed Contributor Insights rule for an Amazon Web Services resource.

    • TemplateName (string) – [REQUIRED]

      The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules.

    • ResourceARN (string) – [REQUIRED]

      The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.

    • Tags (list) –

      A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to scope user permissions by granting a user permission to access or change only the resources that have certain tag values. 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 that 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

{
    'Failures': [
        {
            'FailureResource': 'string',
            'ExceptionType': 'string',
            'FailureCode': 'string',
            'FailureDescription': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Failures (list) –

      An array that lists the rules that could not be enabled.

      • (dict) –

        This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

        • FailureResource (string) –

          The specified rule that could not be deleted.

        • ExceptionType (string) –

          The type of error.

        • FailureCode (string) –

          The code of the error.

        • FailureDescription (string) –

          A description of the error.

Exceptions

  • CloudWatch.Client.exceptions.InvalidParameterValueException

  • CloudWatch.Client.exceptions.MissingRequiredParameterException