Skip to content

Commit

Permalink
docs(client-cloudwatch): Support for configuring AiOps investigation …
Browse files Browse the repository at this point in the history 
…as alarm action
  • Loading branch information
awstools committed Dec 3, 2024
1 parent 86fba5d commit 89b254c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
20 changes: 18 additions & 2 deletions clients/client-cloudwatch/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2097,7 +2097,8 @@ export interface Entity {
* <p>There are five allowed attributes (key names): <code>Type</code>,
* <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and
* <code>Environment</code>.</p>
* <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
* <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
* to add related
* information to telemetry</a> in the <i>CloudWatch User
* Guide</i>.</p>
* @public
Expand All @@ -2107,7 +2108,8 @@ export interface Entity {
/**
* <p>Additional attributes of the entity that are not used to specify the identity of the
* entity. A list of key-value pairs.</p>
* <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
* <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
* to add related information to
* telemetry</a> in the <i>CloudWatch User Guide</i>.</p>
* @public
*/
Expand Down Expand Up @@ -3797,6 +3799,13 @@ export interface PutCompositeAlarmInput {
* <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
* </code>
* </p>
* <p>
* <b>Start a Amazon Q Developer operational investigation</b>
* </p>
* <p>
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>
* </code>
* </p>
* @public
*/
AlarmActions?: string[] | undefined;
Expand Down Expand Up @@ -4407,6 +4416,13 @@ export interface PutMetricAlarmInput {
* </p>
* </li>
* </ul>
* <p>
* <b>Start a Amazon Q Developer operational investigation</b>
* </p>
* <p>
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>ingestigation-group-id</i>
* </code>
* </p>
* @public
*/
AlarmActions?: string[] | undefined;
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/cloudwatch.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1818,13 +1818,13 @@
"KeyAttributes": {
"target": "com.amazonaws.cloudwatch#EntityKeyAttributesMap",
"traits": {
"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>"
"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>"
}
},
"Attributes": {
"target": "com.amazonaws.cloudwatch#EntityAttributesMap",
"traits": {
"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>"
"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>"
}
}
},
Expand Down Expand Up @@ -5685,7 +5685,7 @@
"AlarmActions": {
"target": "com.amazonaws.cloudwatch#ResourceList",
"traits": {
"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>"
"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>"
}
},
"AlarmDescription": {
Expand Down Expand Up @@ -5974,7 +5974,7 @@
"AlarmActions": {
"target": "com.amazonaws.cloudwatch#ResourceList",
"traits": {
"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>"
"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>"
}
},
"InsufficientDataActions": {
Expand Down

0 comments on commit 89b254c

Please sign in to comment.