Skip to content

Commit 6aa6dac

Browse files
author
AWS
committed
Amazon CloudWatch Update: Add support for managed Contributor Insights Rules
1 parent 88a7026 commit 6aa6dac

File tree

3 files changed

+181
-2
lines changed

3 files changed

+181
-2
lines changed

‎.changes/next-release/feature-AmazonCloudWatch-7946d8b.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon CloudWatch",
4+
"contributor": "",
5+
"description": "Add support for managed Contributor Insights Rules"
6+
}

‎services/cloudwatch/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818
"DescribeAlarmsForMetric": {
1919
"result_key": "MetricAlarms"
2020
},
21+
"DescribeAnomalyDetectors": {
22+
"input_token": "NextToken",
23+
"limit_key": "MaxResults",
24+
"output_token": "NextToken",
25+
"result_key": "AnomalyDetectors"
26+
},
2127
"DescribeInsightRules": {
2228
"input_token": "NextToken",
2329
"limit_key": "MaxResults",
@@ -37,6 +43,11 @@
3743
"output_token": "NextToken",
3844
"result_key": "DashboardEntries"
3945
},
46+
"ListManagedInsightRules": {
47+
"input_token": "NextToken",
48+
"limit_key": "MaxResults",
49+
"output_token": "NextToken"
50+
},
4051
"ListMetricStreams": {
4152
"input_token": "NextToken",
4253
"limit_key": "MaxResults",

‎services/cloudwatch/src/main/resources/codegen-resources/service-2.json

Lines changed: 164 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,24 @@
351351
],
352352
"documentation":"<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. </p> <p> <code>ListDashboards</code> returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call <code>ListDashboards</code> again and include the value you received for <code>NextToken</code> in the first call, to receive the next 1000 results.</p>"
353353
},
354+
"ListManagedInsightRules":{
355+
"name":"ListManagedInsightRules",
356+
"http":{
357+
"method":"POST",
358+
"requestUri":"/"
359+
},
360+
"input":{"shape":"ListManagedInsightRulesInput"},
361+
"output":{
362+
"shape":"ListManagedInsightRulesOutput",
363+
"resultWrapper":"ListManagedInsightRulesResult"
364+
},
365+
"errors":[
366+
{"shape":"InvalidParameterValueException"},
367+
{"shape":"MissingRequiredParameterException"},
368+
{"shape":"InvalidNextToken"}
369+
],
370+
"documentation":"<p> Returns a list that contains the number of managed Contributor Insights rules in your account. </p>"
371+
},
354372
"ListMetricStreams":{
355373
"name":"ListMetricStreams",
356374
"http":{
@@ -472,6 +490,23 @@
472490
],
473491
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html\">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p> <p>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.</p>"
474492
},
493+
"PutManagedInsightRules":{
494+
"name":"PutManagedInsightRules",
495+
"http":{
496+
"method":"POST",
497+
"requestUri":"/"
498+
},
499+
"input":{"shape":"PutManagedInsightRulesInput"},
500+
"output":{
501+
"shape":"PutManagedInsightRulesOutput",
502+
"resultWrapper":"PutManagedInsightRulesResult"
503+
},
504+
"errors":[
505+
{"shape":"InvalidParameterValueException"},
506+
{"shape":"MissingRequiredParameterException"}
507+
],
508+
"documentation":"<p> 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 <code>PutInsightRule</code>. The rules can be enabled, disabled, and deleted using <code>EnableInsightRules</code>, <code>DisableInsightRules</code>, and <code>DeleteInsightRules</code>. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use <code>ListManagedInsightRules</code> to describe all available rules. </p>"
509+
},
475510
"PutMetricAlarm":{
476511
"name":"PutMetricAlarm",
477512
"http":{
@@ -1825,7 +1860,7 @@
18251860
},
18261861
"OutputFormat":{
18271862
"shape":"MetricStreamOutputFormat",
1828-
"documentation":"<p>The output format for the stream. Valid values are <code>json</code> and <code>opentelemetry0.7</code>. For more information about metric stream output formats, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html\"> Metric streams output formats</a>.</p>"
1863+
"documentation":"<p>The output format for the stream. Valid values are <code>json</code> and <code>opentelemetry0.7</code>. For more information about metric stream output formats, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html\">Metric streams output formats</a>.</p>"
18291864
},
18301865
"StatisticsConfigurations":{
18311866
"shape":"MetricStreamStatisticsConfigurations",
@@ -1898,6 +1933,10 @@
18981933
"Definition":{
18991934
"shape":"InsightRuleDefinition",
19001935
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html\">Contributor Insights Rule Syntax</a>.</p>"
1936+
},
1937+
"ManagedRule":{
1938+
"shape":"InsightRuleIsManaged",
1939+
"documentation":"<p> An optional built-in rule that Amazon Web Services manages. </p>"
19011940
}
19021941
},
19031942
"documentation":"<p>This structure contains the definition for a Contributor Insights rule. For more information about this rule, see<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html\"> Using Constributor Insights to analyze high-cardinality data</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
@@ -1968,6 +2007,7 @@
19682007
"min":1,
19692008
"pattern":"[\\x00-\\x7F]+"
19702009
},
2010+
"InsightRuleIsManaged":{"type":"boolean"},
19712011
"InsightRuleMaxResults":{
19722012
"type":"integer",
19732013
"max":500,
@@ -2203,6 +2243,37 @@
22032243
}
22042244
}
22052245
},
2246+
"ListManagedInsightRulesInput":{
2247+
"type":"structure",
2248+
"required":["ResourceARN"],
2249+
"members":{
2250+
"ResourceARN":{
2251+
"shape":"AmazonResourceName",
2252+
"documentation":"<p> The ARN of an Amazon Web Services resource that has managed Contributor Insights rules. </p>"
2253+
},
2254+
"NextToken":{
2255+
"shape":"NextToken",
2256+
"documentation":"<p> Include this value to get the next set of rules if the value was returned by the previous operation. </p>"
2257+
},
2258+
"MaxResults":{
2259+
"shape":"InsightRuleMaxResults",
2260+
"documentation":"<p> The maximum number of results to return in one operation. If you omit this parameter, the default number is used. The default number is <code>100</code>. </p>"
2261+
}
2262+
}
2263+
},
2264+
"ListManagedInsightRulesOutput":{
2265+
"type":"structure",
2266+
"members":{
2267+
"ManagedRules":{
2268+
"shape":"ManagedRuleDescriptions",
2269+
"documentation":"<p> The managed rules that are available for the specified Amazon Web Services resource. </p>"
2270+
},
2271+
"NextToken":{
2272+
"shape":"NextToken",
2273+
"documentation":"<p> Include this value to get the next set of rules if the value was returned by the previous operation. </p>"
2274+
}
2275+
}
2276+
},
22062277
"ListMetricStreamsInput":{
22072278
"type":"structure",
22082279
"members":{
@@ -2295,6 +2366,72 @@
22952366
}
22962367
}
22972368
},
2369+
"ManagedRule":{
2370+
"type":"structure",
2371+
"required":[
2372+
"TemplateName",
2373+
"ResourceARN"
2374+
],
2375+
"members":{
2376+
"TemplateName":{
2377+
"shape":"TemplateName",
2378+
"documentation":"<p> The template name for the managed Contributor Insights rule, as returned by <code>ListManagedInsightRules</code>. </p>"
2379+
},
2380+
"ResourceARN":{
2381+
"shape":"AmazonResourceName",
2382+
"documentation":"<p> The ARN of an Amazon Web Services resource that has managed Contributor Insights rules. </p>"
2383+
},
2384+
"Tags":{
2385+
"shape":"TagList",
2386+
"documentation":"<p> 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 <code>cloudwatch:TagResource</code> permission in addition to the <code>cloudwatch:PutInsightRule</code> 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 <code>TagResource</code>. </p>"
2387+
}
2388+
},
2389+
"documentation":"<p> Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource. </p>"
2390+
},
2391+
"ManagedRuleDescription":{
2392+
"type":"structure",
2393+
"members":{
2394+
"TemplateName":{
2395+
"shape":"TemplateName",
2396+
"documentation":"<p> The template name for the managed rule. Used to enable managed rules using <code>PutManagedInsightRules</code>. </p>"
2397+
},
2398+
"ResourceARN":{
2399+
"shape":"AmazonResourceName",
2400+
"documentation":"<p> If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource. </p>"
2401+
},
2402+
"RuleState":{
2403+
"shape":"ManagedRuleState",
2404+
"documentation":"<p> Describes the state of a managed rule. If present, it contains information about the Contributor Insights rule that contains information about the related Amazon Web Services resource. </p>"
2405+
}
2406+
},
2407+
"documentation":"<p> Contains information about managed Contributor Insights rules, as returned by <code>ListManagedInsightRules</code>. </p>"
2408+
},
2409+
"ManagedRuleDescriptions":{
2410+
"type":"list",
2411+
"member":{"shape":"ManagedRuleDescription"}
2412+
},
2413+
"ManagedRuleState":{
2414+
"type":"structure",
2415+
"required":[
2416+
"RuleName",
2417+
"State"
2418+
],
2419+
"members":{
2420+
"RuleName":{
2421+
"shape":"InsightRuleName",
2422+
"documentation":"<p> The name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource. </p>"
2423+
},
2424+
"State":{
2425+
"shape":"InsightRuleState",
2426+
"documentation":"<p> Indicates whether the rule is enabled or disabled. </p>"
2427+
}
2428+
},
2429+
"documentation":"<p> The status of a managed Contributor Insights rule. </p>"
2430+
},
2431+
"ManagedRules":{
2432+
"type":"list",
2433+
"member":{"shape":"ManagedRule"}
2434+
},
22982435
"MaxRecords":{
22992436
"type":"integer",
23002437
"max":100,
@@ -2598,7 +2735,7 @@
25982735
},
25992736
"Values":{
26002737
"shape":"Values",
2601-
"documentation":"<p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period. You can include up to 500 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p> <p>Although the <code>Values</code> array accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p>"
2738+
"documentation":"<p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p> <p>Although the <code>Values</code> array accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p>"
26022739
},
26032740
"Counts":{
26042741
"shape":"Counts",
@@ -3000,6 +3137,25 @@
30003137
"members":{
30013138
}
30023139
},
3140+
"PutManagedInsightRulesInput":{
3141+
"type":"structure",
3142+
"required":["ManagedRules"],
3143+
"members":{
3144+
"ManagedRules":{
3145+
"shape":"ManagedRules",
3146+
"documentation":"<p> A list of <code>ManagedRules</code> to enable. </p>"
3147+
}
3148+
}
3149+
},
3150+
"PutManagedInsightRulesOutput":{
3151+
"type":"structure",
3152+
"members":{
3153+
"Failures":{
3154+
"shape":"BatchFailures",
3155+
"documentation":"<p> An array that lists the rules that could not be enabled. </p>"
3156+
}
3157+
}
3158+
},
30033159
"PutMetricAlarmInput":{
30043160
"type":"structure",
30053161
"required":[
@@ -3488,6 +3644,12 @@
34883644
"max":256,
34893645
"min":0
34903646
},
3647+
"TemplateName":{
3648+
"type":"string",
3649+
"max":128,
3650+
"min":1,
3651+
"pattern":"[0-9A-Za-z][\\-\\.\\_0-9A-Za-z]{0,126}[0-9A-Za-z]"
3652+
},
34913653
"Threshold":{"type":"double"},
34923654
"Timestamp":{"type":"timestamp"},
34933655
"Timestamps":{

0 commit comments

Comments
 (0)