AIOps / Client / create_investigation_group

create_investigation_group

AIOps.Client.create_investigation_group(**kwargs)

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 Amazon Q Developer operational 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.

Warning

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms to work with Amazon Q Developer operational investigations, see

See also: AWS API Documentation

Request Syntax

response = 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
)
Parameters:

  • name (string) –

    [REQUIRED]

    A name for the investigation group.

  • roleArn (string) –

    [REQUIRED]

    Specify the ARN of the IAM role that Amazon Q Developer operational investigations will use when it gathers investigation data. 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 How 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.

  • retentionInDays (integer) –

    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.

  • tags (dict) –

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

  • 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

{
    'arn': 'string'
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the investigation group that you just created.

Exceptions