AIOps / Client / get_investigation_group

get_investigation_group

AIOps.Client.get_investigation_group(**kwargs)

Returns the configuration information for the specified investigation group.

See also: AWS API Documentation

Request Syntax

response = client.get_investigation_group(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

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

Return type:

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
}

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 Amazon Q Developer operational investigationshas access to change events that are recorded by CloudTrail.

Exceptions