Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateInvestigationGroup

Updates the configuration of the specified investigation group.

Request Syntax


PATCH /investigationGroups/identifier HTTP/1.1
Content-type: application/json

{
   "chatbotNotificationChannel": { 
      "string" : [ "string" ]
   },
   "crossAccountConfigurations": [ 
      { 
         "sourceRoleArn": "string"
      }
   ],
   "encryptionConfiguration": { 
      "kmsKeyId": "string",
      "type": "string"
   },
   "isCloudTrailEventHistoryEnabled": boolean,
   "roleArn": "string",
   "tagKeyBoundaries": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

identifier

Specify either the name or the ARN of the investigation group that you want to modify.

Pattern: (?:[\-_A-Za-z0-9]{1,512}|arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):aiops:[a-zA-Z0-9-]*:[0-9]{12}:investigation-group\/[A-Za-z0-9]{16})

Required: Yes

Request Body

The request accepts the following data in JSON format.

chatbotNotificationChannel

Use this structure to integrate CloudWatch investigations with chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by AWS Chatbot.

Type: String to array of strings map

Key Length Constraints: Minimum length of 20. Maximum length of 2048.

Key Pattern: arn:.*

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

Required: No

crossAccountConfigurations

Used to configure cross-account access for an investigation group. It allows the investigation group to access resources in other accounts.

Type: Array of CrossAccountConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Required: No

encryptionConfiguration

Use this structure if you want to use a customer managed AWS KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch investigations will use an AWS key to encrypt the data. For more information, see Encryption of investigation data.

Type: EncryptionConfiguration object

Required: No

isCloudTrailEventHistoryEnabled

Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is true.

Type: Boolean

Required: No

roleArn

Specify this field if you want to change the IAM role that CloudWatch investigations will use when it gathers investigation data. To do so, specify the ARN of the new role.

The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see How to control what data CloudWatch investigations has access to during investigations.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

Required: No

tagKeyBoundaries

Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.

You don't need to enter tags created by myApplications or AWS CloudFormation, because CloudWatch investigations can automatically detect those tags.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]+)

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

This operation couldn't be completed because of a conflict in resource states.

HTTP Status Code: 409

ForbiddenException

Access id denied for this operation, or this operation is not valid for the specified resource.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. You can try again later.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was throttled because of quota limits. You can try again later.

HTTP Status Code: 429

ValidationException

This operation or its parameters aren't formatted correctly.

HTTP Status Code: 400