Skip to content

Commit 89b254c

Browse files
author
awstools
committed
docs(client-cloudwatch): Support for configuring AiOps investigation as alarm action
1 parent 86fba5d commit 89b254c

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

‎clients/client-cloudwatch/src/models/models_0.ts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2097,7 +2097,8 @@ export interface Entity {
20972097
* <p>There are five allowed attributes (key names): <code>Type</code>,
20982098
* <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and
20992099
* <code>Environment</code>.</p>
2100-
* <p>For details about how to use the key attributes to specify an entity, see <a href="https://docs.aws.amazon.com/adding-your-own-related-telemetry.html">How to add related
2100+
* <p>For details about how to use the key attributes to specify an entity, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How
2101+
* to add related
21012102
* information to telemetry</a> in the <i>CloudWatch User
21022103
* Guide</i>.</p>
21032104
* @public
@@ -2107,7 +2108,8 @@ export interface Entity {
21072108
/**
21082109
* <p>Additional attributes of the entity that are not used to specify the identity of the
21092110
* entity. A list of key-value pairs.</p>
2110-
* <p>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/adding-your-own-related-telemetry.html">How to add related information to
2111+
* <p>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How
2112+
* to add related information to
21112113
* telemetry</a> in the <i>CloudWatch User Guide</i>.</p>
21122114
* @public
21132115
*/
@@ -3797,6 +3799,13 @@ export interface PutCompositeAlarmInput {
37973799
* <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
37983800
* </code>
37993801
* </p>
3802+
* <p>
3803+
* <b>Start a Amazon Q Developer operational investigation</b>
3804+
* </p>
3805+
* <p>
3806+
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>
3807+
* </code>
3808+
* </p>
38003809
* @public
38013810
*/
38023811
AlarmActions?: string[] | undefined;
@@ -4407,6 +4416,13 @@ export interface PutMetricAlarmInput {
44074416
* </p>
44084417
* </li>
44094418
* </ul>
4419+
* <p>
4420+
* <b>Start a Amazon Q Developer operational investigation</b>
4421+
* </p>
4422+
* <p>
4423+
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>
4424+
* </code>
4425+
* </p>
44104426
* @public
44114427
*/
44124428
AlarmActions?: string[] | undefined;

‎codegen/sdk-codegen/aws-models/cloudwatch.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1818,13 +1818,13 @@
18181818
"KeyAttributes": {
18191819
"target": "com.amazonaws.cloudwatch#EntityKeyAttributesMap",
18201820
"traits": {
1821-
"smithy.api#documentation": "<p>The attributes of the entity which identify the specific entity, as a list of \n key-value pairs. Entities with the same <code>KeyAttributes</code> are considered to be\n the same entity. For an entity to be valid, the <code>KeyAttributes</code> must exist\n and be formatted correctly.</p>\n <p>There are five allowed attributes (key names): <code>Type</code>,\n <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and\n <code>Environment</code>.</p>\n <p>For details about how to use the key attributes to specify an entity, see <a href=\"https://docs.aws.amazon.com/adding-your-own-related-telemetry.html\">How to add related \n information to telemetry</a> in the <i>CloudWatch User \n Guide</i>.</p>"
1821+
"smithy.api#documentation": "<p>The attributes of the entity which identify the specific entity, as a list of \n key-value pairs. Entities with the same <code>KeyAttributes</code> are considered to be\n the same entity. For an entity to be valid, the <code>KeyAttributes</code> must exist\n and be formatted correctly.</p>\n <p>There are five allowed attributes (key names): <code>Type</code>,\n <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and\n <code>Environment</code>.</p>\n <p>For details about how to use the key attributes to specify an entity, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html\">How \n to add related \n information to telemetry</a> in the <i>CloudWatch User \n Guide</i>.</p>"
18221822
}
18231823
},
18241824
"Attributes": {
18251825
"target": "com.amazonaws.cloudwatch#EntityAttributesMap",
18261826
"traits": {
1827-
"smithy.api#documentation": "<p>Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.</p>\n <p>For details about how to use the attributes, see <a href=\"https://docs.aws.amazon.com/adding-your-own-related-telemetry.html\">How to add related information to \n telemetry</a> in the <i>CloudWatch User Guide</i>.</p>"
1827+
"smithy.api#documentation": "<p>Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.</p>\n <p>For details about how to use the attributes, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html\">How \n to add related information to \n telemetry</a> in the <i>CloudWatch User Guide</i>.</p>"
18281828
}
18291829
}
18301830
},
@@ -5685,7 +5685,7 @@
56855685
"AlarmActions": {
56865686
"target": "com.amazonaws.cloudwatch#ResourceList",
56875687
"traits": {
5688-
"smithy.api#documentation": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).</p>\n <p>Valid Values: ]</p>\n <p>\n <b>Amazon SNS actions:</b>\n </p>\n <p>\n <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>\n </code>\n </p>\n <p>\n <b>Lambda actions:</b>\n </p>\n <ul>\n <li>\n <p>Invoke the latest version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a specific version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a function by using an alias Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>Systems Manager actions:</b>\n </p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>\n </code>\n </p>"
5688+
"smithy.api#documentation": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).</p>\n <p>Valid Values: ]</p>\n <p>\n <b>Amazon SNS actions:</b>\n </p>\n <p>\n <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>\n </code>\n </p>\n <p>\n <b>Lambda actions:</b>\n </p>\n <ul>\n <li>\n <p>Invoke the latest version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a specific version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a function by using an alias Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>Systems Manager actions:</b>\n </p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>\n </code>\n </p>\n <p>\n <b>Start a Amazon Q Developer operational investigation</b>\n </p>\n <p>\n <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>\n </code>\n </p>"
56895689
}
56905690
},
56915691
"AlarmDescription": {
@@ -5974,7 +5974,7 @@
59745974
"AlarmActions": {
59755975
"target": "com.amazonaws.cloudwatch#ResourceList",
59765976
"traits": {
5977-
"smithy.api#documentation": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:</p>\n <p>\n <b>EC2 actions:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:stop</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:terminate</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:reboot</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:recover</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Recover/1.0</code>\n </p>\n </li>\n </ul>\n <p>\n <b>Autoscaling action:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>Lambda actions:</b>\n </p>\n <ul>\n <li>\n <p>Invoke the latest version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a specific version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a function by using an alias Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>SNS notification action:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>SSM integration actions:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>#CATEGORY=<i>category-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:ssm-incidents::<i>account-id</i>:responseplan/<i>response-plan-name</i>\n </code>\n </p>\n </li>\n </ul>"
5977+
"smithy.api#documentation": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:</p>\n <p>\n <b>EC2 actions:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:stop</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:terminate</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:reboot</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:automate:<i>region</i>:ec2:recover</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Recover/1.0</code>\n </p>\n </li>\n </ul>\n <p>\n <b>Autoscaling action:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>Lambda actions:</b>\n </p>\n <ul>\n <li>\n <p>Invoke the latest version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a specific version of a Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>\n </code>\n </p>\n </li>\n <li>\n <p>Invoke a function by using an alias Lambda function:\n <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>SNS notification action:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>SSM integration actions:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>#CATEGORY=<i>category-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:ssm-incidents::<i>account-id</i>:responseplan/<i>response-plan-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>\n <b>Start a Amazon Q Developer operational investigation</b>\n </p>\n <p>\n <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>\n </code>\n </p>"
59785978
}
59795979
},
59805980
"InsufficientDataActions": {

0 commit comments

Comments
 (0)