feat(client-aiops): Adds support for cross account investigations for CloudWatch investigations AI Operations (AIOps).

Author: awstools

clients/client-aiops/README.md

@@ -6,7 +6,7 @@
 
 AWS SDK for JavaScript AIOps Client for Node.js, Browser and React Native.
 
-<p>The Amazon Q Developer operational investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
+<p>The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
 
 ## Installing
 

clients/client-aiops/src/AIOps.ts

@@ -248,7 +248,7 @@ export interface AIOps {
 }
 
 /**
- * <p>The Amazon Q Developer operational investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
+ * <p>The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
  * @public
  */
 export class AIOps extends AIOpsClient implements AIOps {}

clients/client-aiops/src/AIOpsClient.ts

@@ -325,7 +325,7 @@ export type AIOpsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
 export interface AIOpsClientResolvedConfig extends AIOpsClientResolvedConfigType {}
 
 /**
- * <p>The Amazon Q Developer operational investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
+ * <p>The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
  * @public
  */
 export class AIOpsClient extends __Client<

clients/client-aiops/src/commands/CreateInvestigationGroupCommand.ts

@@ -28,7 +28,7 @@ export interface CreateInvestigationGroupCommandInput extends CreateInvestigatio
 export interface CreateInvestigationGroupCommandOutput extends CreateInvestigationGroupOutput, __MetadataBearer {}
 
 /**
- * <p>Creates an <i>investigation group</i> in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.</p> <p>Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:</p> <ul> <li> <p>Who can access the investigations</p> </li> <li> <p>Whether investigation data is encrypted with a customer managed Key Management Service key.</p> </li> <li> <p>How long investigations and their data are retained by default.</p> </li> </ul> <p>Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region</p> <p>To create an investigation group and set up Amazon Q Developer operational investigations, you must be signed in to an IAM principal that has the either the <code>AIOpsConsoleAdminPolicy</code> or the <code>AdministratorAccess</code> IAM policy attached, or to an account that has similar permissions.</p> <important> <p>You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <a href="https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_PutInvestigationGroupPolicy.html">PutInvestigationGroupPolicy</a> to create a resource policy that grants this permission to CloudWatch alarms. </p> <p>For more information about configuring CloudWatch alarms to work with Amazon Q Developer operational investigations, see </p> </important>
+ * <p>Creates an <i>investigation group</i> in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.</p> <p>Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:</p> <ul> <li> <p>Who can access the investigations</p> </li> <li> <p>Whether investigation data is encrypted with a customer managed Key Management Service key.</p> </li> <li> <p>How long investigations and their data are retained by default.</p> </li> </ul> <p>Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region</p> <p>To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has the either the <code>AIOpsConsoleAdminPolicy</code> or the <code>AdministratorAccess</code> IAM policy attached, or to an account that has similar permissions.</p> <important> <p>You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <a href="https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_PutInvestigationGroupPolicy.html">PutInvestigationGroupPolicy</a> to create a resource policy that grants this permission to CloudWatch alarms. </p> <p>For more information about configuring CloudWatch alarms to work with CloudWatch investigations, see </p> </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,6 +55,11 @@ export interface CreateInvestigationGroupCommandOutput extends CreateInvestigati
  *     ],
  *   },
  *   isCloudTrailEventHistoryEnabled: true || false,
+ *   crossAccountConfigurations: [ // CrossAccountConfigurations
+ *     { // CrossAccountConfiguration
+ *       sourceRoleArn: "STRING_VALUE",
+ *     },
+ *   ],
  * };
  * const command = new CreateInvestigationGroupCommand(input);
  * const response = await client.send(command);

clients/client-aiops/src/commands/GetInvestigationGroupCommand.ts

@@ -62,6 +62,11 @@ export interface GetInvestigationGroupCommandOutput extends GetInvestigationGrou
  * //     "STRING_VALUE",
  * //   ],
  * //   isCloudTrailEventHistoryEnabled: true || false,
+ * //   crossAccountConfigurations: [ // CrossAccountConfigurations
+ * //     { // CrossAccountConfiguration
+ * //       sourceRoleArn: "STRING_VALUE",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

clients/client-aiops/src/commands/ListTagsForResourceCommand.ts

@@ -28,7 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {}
 
 /**
- * <p>Displays the tags associated with a Amazon Q Developer operational investigations resource. Currently, investigation groups support tagging.</p>
+ * <p>Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-aiops/src/commands/UpdateInvestigationGroupCommand.ts

@@ -51,6 +51,11 @@ export interface UpdateInvestigationGroupCommandOutput extends UpdateInvestigati
  *     ],
  *   },
  *   isCloudTrailEventHistoryEnabled: true || false,
+ *   crossAccountConfigurations: [ // CrossAccountConfigurations
+ *     { // CrossAccountConfiguration
+ *       sourceRoleArn: "STRING_VALUE",
+ *     },
+ *   ],
  * };
  * const command = new UpdateInvestigationGroupCommand(input);
  * const response = await client.send(command);

clients/client-aiops/src/index.ts

@@ -1,7 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>The Amazon Q Developer operational investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
+ * <p>The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>
  *
  * @packageDocumentation
  */