[ aws . cloudwatch ]

put-managed-insight-rules

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-managed-insight-rules
--managed-rules <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--managed-rules (list)

A list of ManagedRules to enable.

(structure)

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

TemplateName -> (string)

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

ResourceARN -> (string)

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 .

(structure)

A key-value pair associated with a CloudWatch resource.

Key -> (string)

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)

The value for the specified tag key.

Shorthand Syntax:

TemplateName=string,ResourceARN=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "TemplateName": "string",
    "ResourceARN": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Failures -> (list)

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

(structure)

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.