create_investigation_group async ¶

async def create_investigation_group(
    self,
    name: "capo_aiops.types.string_with_pattern_and_length_limits.StringWithPatternAndLengthLimits",
    role_arn: "capo_aiops.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[AsyncAIOpsClientConfig] = None,
    encryption_configuration: Optional[
        "capo_aiops.types.encryption_configuration.EncryptionConfiguration"
    ] = None,
    retention_in_days: Optional["capo_aiops.types.retention.Retention"] = None,
    tags: Optional["capo_aiops.types.tags.Tags"] = None,
    tag_key_boundaries: Optional[
        "capo_aiops.types.tag_key_boundaries.TagKeyBoundaries"
    ] = None,
    chatbot_notification_channel: Optional[
        "capo_aiops.types.chatbot_notification_channel.ChatbotNotificationChannel"
    ] = None,
    is_cloud_trail_event_history_enabled: Optional[bool] = None,
    cross_account_configurations: Optional[
        "capo_aiops.types.cross_account_configurations.CrossAccountConfigurations"
    ] = None,
) -> "capo_aiops.types.create_investigation_group_output.CreateInvestigationGroupOutput":
    """<p>Creates an <i>investigation group</i> 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.</p> <p>Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:</p> <ul> <li> <p>Who can access the investigations</p> </li> <li> <p>Whether investigation data is encrypted with a customer managed Key Management Service key.</p> </li> <li> <p>How long investigations and their data are retained by default.</p> </li> </ul> <p>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</p> <p>To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the <code>AIOpsConsoleAdminPolicy</code> or the <code>AdministratorAccess</code> IAM policy attached, or to an account that has similar permissions.</p> <important> <p>You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms. </p> <p>For more information about configuring CloudWatch alarms, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html">Using Amazon CloudWatch alarms</a> </p> </important>

    Args:
        name: <p>Provides a name for the investigation group.</p>
        role_arn: <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data">How to control what data CloudWatch investigations has access to during investigations</a>.</p>
        encryption_configuration: <p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS">Encryption of investigation data</a>.</p>
        retention_in_days: <p>Specify how long that investigation data is kept. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Retention.html">Operational investigation data retention</a>. </p> <p>If you omit this parameter, the default of 90 days is used.</p>
        tags: <p>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 <code>cloudwatch:TagResource</code> permission.</p> <p>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.</p>
        tag_key_boundaries: <p>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.</p> <p>You don't need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.</p>
        chatbot_notification_channel: <p>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 <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html">Getting started with Amazon Q in chat applications</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies">Resource type defined by Amazon Web Services Chatbot</a>.</p>
        is_cloud_trail_event_history_enabled: <p>Specify <code>true</code> to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is <code>true</code>.</p>
        cross_account_configurations: <p>List of <code>sourceRoleArn</code> values that have been configured for cross-account access.</p>

    Raises:
        capo_aiops.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_aiops.errors.conflict_exception.ConflictException: <p>This operation couldn't be completed because of a conflict in resource states.</p>
        capo_aiops.errors.forbidden_exception.ForbiddenException: <p>Access id denied for this operation, or this operation is not valid for the specified resource.</p>
        capo_aiops.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. You can try again later.</p>
        capo_aiops.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
        capo_aiops.errors.validation_exception.ValidationException: <p>This operation or its parameters aren't formatted correctly.</p>
        capo_aiops.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This request exceeds a service quota.</p>
        capo_aiops.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits. You can try again later.</p>
        capo_aiops.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_aiops.types.create_investigation_group_input.CreateInvestigationGroupInput]",
    ) -> AsyncOperationResponse[
        "capo_aiops.types.create_investigation_group_output.CreateInvestigationGroupOutput"
    ]:
        import capo_aiops._operations.ai_ops.create_investigation_group

        (
            output,
            http_response,
        ) = await capo_aiops._operations.ai_ops.create_investigation_group.async_create_investigation_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateInvestigationGroup")
    )
    input_: capo_aiops.types.create_investigation_group_input.CreateInvestigationGroupInput = {
        "name": name,
        "role_arn": role_arn,
    }
    if encryption_configuration is not None:
        input_["encryption_configuration"] = encryption_configuration
    if retention_in_days is not None:
        input_["retention_in_days"] = retention_in_days
    if tags is not None:
        input_["tags"] = tags
    if tag_key_boundaries is not None:
        input_["tag_key_boundaries"] = tag_key_boundaries
    if chatbot_notification_channel is not None:
        input_["chatbot_notification_channel"] = chatbot_notification_channel
    if is_cloud_trail_event_history_enabled is not None:
        input_["is_cloud_trail_event_history_enabled"] = (
            is_cloud_trail_event_history_enabled
        )
    if cross_account_configurations is not None:
        input_["cross_account_configurations"] = cross_account_configurations

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output