AIOps / Client / update_investigation_group

update_investigation_group

AIOps.Client.update_investigation_group(**kwargs)

Updates the configuration of the specified investigation group.

See also: AWS API Documentation

Request Syntax

response = client.update_investigation_group(
    identifier='string',
    roleArn='string',
    encryptionConfiguration={
        'type': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KMS_KEY',
        'kmsKeyId': 'string'
    },
    tagKeyBoundaries=[
        'string',
    ],
    chatbotNotificationChannel={
        'string': [
            'string',
        ]
    },
    isCloudTrailEventHistoryEnabled=True|False
)
Parameters:
  • identifier (string) –

    [REQUIRED]

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

  • roleArn (string) –

    Specify this field if you want to change the IAM role that Amazon Q Developer operational 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 Amazon Q Developer operational investigations will have access to during investigations.

    For more information, see EHow to control what data Amazon Q has access to during investigations.

  • encryptionConfiguration (dict) –

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

    • type (string) –

      Displays whether investigation data is encrypted by a customer managed key or an Amazon Web Services owned kay.

    • kmsKeyId (string) –

      If the investigation group uses a customer managed key for encryption, this field displays the ID of that key.

  • tagKeyBoundaries (list) –

    Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q 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, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven’t deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.

    You don’t need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.

    • (string) –

  • chatbotNotificationChannel (dict) –

    Use this structure to integrate Amazon Q Developer operational investigations with Amazon Q in 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 Amazon Q in 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 Amazon Web Services Chatbot.

    • (string) –

      • (list) –

        • (string) –

  • isCloudTrailEventHistoryEnabled (boolean) – Specify true to enable Amazon Q Developer operational investigations to have access to change events that are recorded by CloudTrail. The default is true.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions