AWS AI Ops

2025/06/24 - AWS AI Ops - 3 updated api methods

Changes  Adds support for cross account investigations for CloudWatch investigations AI Operations (AIOps).

CreateInvestigationGroup (updated) Link ¶
Changes (request) 
{'crossAccountConfigurations': [{'sourceRoleArn': 'string'}]}

Creates an investigation group 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.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

  • Who can access the investigations

  • Whether investigation data is encrypted with a customer managed Key Management Service key.

  • How long investigations and their data are retained by default.

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

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has the either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

See also: AWS API Documentation

Request Syntax

client.create_investigation_group(
    name='string',
    roleArn='string',
    encryptionConfiguration={
        'type': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KMS_KEY',
        'kmsKeyId': 'string'
    },
    retentionInDays=123,
    tags={
        'string': 'string'
    },
    tagKeyBoundaries=[
        'string',
    ],
    chatbotNotificationChannel={
        'string': [
            'string',
        ]
    },
    isCloudTrailEventHistoryEnabled=True|False,
    crossAccountConfigurations=[
        {
            'sourceRoleArn': 'string'
        },
    ]
)
type name:

string

param name:

[REQUIRED]

Provides a name for the investigation group.

type roleArn:

string

param roleArn:

[REQUIRED]

Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data. 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 Amazon Q has access to during investigations.

type encryptionConfiguration:

dict

param encryptionConfiguration:

Use this structure if you want to use a customer managed KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch 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.

type retentionInDays:

integer

param retentionInDays:

Specify how long that investigation data is kept. For more information, see Operational investigation data retention.

If you omit this parameter, the default of 90 days is used.

type tags:

dict

param tags:

A list of key-value pairs to associate with the investigation group. You can associate as many as 50 tags with an investigation group. To be able to associate tags when you create the investigation group, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

  • (string) --

    • (string) --

type tagKeyBoundaries:

list

param tagKeyBoundaries:

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) --

type chatbotNotificationChannel:

dict

param chatbotNotificationChannel:

Use this structure to integrate CloudWatch 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) --

type isCloudTrailEventHistoryEnabled:

boolean

param isCloudTrailEventHistoryEnabled:

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

type crossAccountConfigurations:

list

param crossAccountConfigurations:

Number of sourceAccountId values that have been configured for cross-account access.

  • (dict) --

    This structure contains information about the cross-account configuration in the account.

    • sourceRoleArn (string) --

      The ARN of an existing role which will be used to do investigations on your behalf.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      The ARN of the investigation group that you just created.

GetInvestigationGroup (updated) Link ¶
Changes (response) 
{'crossAccountConfigurations': [{'sourceRoleArn': 'string'}]}

Returns the configuration information for the specified investigation group.

See also: AWS API Documentation

Request Syntax

client.get_investigation_group(
    identifier='string'
)
type identifier:

string

param identifier:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'createdBy': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastModifiedBy': 'string',
    'lastModifiedAt': datetime(2015, 1, 1),
    'name': 'string',
    'arn': 'string',
    'roleArn': 'string',
    'encryptionConfiguration': {
        'type': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KMS_KEY',
        'kmsKeyId': 'string'
    },
    'retentionInDays': 123,
    'chatbotNotificationChannel': {
        'string': [
            'string',
        ]
    },
    'tagKeyBoundaries': [
        'string',
    ],
    'isCloudTrailEventHistoryEnabled': True|False,
    'crossAccountConfigurations': [
        {
            'sourceRoleArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • createdBy (string) --

      The name of the user who created the investigation group.

    • createdAt (datetime) --

      The date and time that the investigation group was created.

    • lastModifiedBy (string) --

      The name of the user who created the investigation group.

    • lastModifiedAt (datetime) --

      The date and time that the investigation group was most recently modified.

    • name (string) --

      The name of the investigation group.

    • arn (string) --

      The Amazon Resource Name (ARN) of the investigation group.

    • roleArn (string) --

      The ARN of the IAM role that the investigation group uses for permissions to gather data.

    • encryptionConfiguration (dict) --

      Specifies the customer managed KMS key that the investigation group uses to encrypt data, if there is one. If not, the investigation group uses an Amazon Web Services key to encrypt the 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.

    • retentionInDays (integer) --

      Specifies how long that investigation data is kept.

    • chatbotNotificationChannel (dict) --

      This structure is a string array. The first string is the ARN of a Amazon SNS topic. The array of strings display the ARNs of Amazon Q in chat applications configurations that are associated 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) --

    • tagKeyBoundaries (list) --

      Displays the custom tag keys for custom applications in your system that you have specified in the investigation group. Resource tags help Amazon Q narrow the search space when it is unable to discover definite relationships between resources.

      • (string) --

    • isCloudTrailEventHistoryEnabled (boolean) --

      Specifies whether CloudWatch investigationshas access to change events that are recorded by CloudTrail.

    • crossAccountConfigurations (list) --

      Lists the AWSAccountId of the accounts configured for cross-account access and the results of the last scan performed on each account.

      • (dict) --

        This structure contains information about the cross-account configuration in the account.

        • sourceRoleArn (string) --

          The ARN of an existing role which will be used to do investigations on your behalf.

UpdateInvestigationGroup (updated) Link ¶
Changes (request) 
{'crossAccountConfigurations': [{'sourceRoleArn': 'string'}]}

Updates the configuration of the specified investigation group.

See also: AWS API Documentation

Request Syntax

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,
    crossAccountConfigurations=[
        {
            'sourceRoleArn': 'string'
        },
    ]
)
type identifier:

string

param identifier:

[REQUIRED]

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

type roleArn:

string

param 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 EHow to control what data Amazon Q has access to during investigations.

type encryptionConfiguration:

dict

param encryptionConfiguration:

Use this structure if you want to use a customer managed KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch 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.

type tagKeyBoundaries:

list

param tagKeyBoundaries:

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) --

type chatbotNotificationChannel:

dict

param chatbotNotificationChannel:

Use this structure to integrate CloudWatch 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) --

type isCloudTrailEventHistoryEnabled:

boolean

param isCloudTrailEventHistoryEnabled:

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

type crossAccountConfigurations:

list

param crossAccountConfigurations:

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

  • (dict) --

    This structure contains information about the cross-account configuration in the account.

    • sourceRoleArn (string) --

      The ARN of an existing role which will be used to do investigations on your behalf.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --