start_detect_mitigation_actions_task ¶

def start_detect_mitigation_actions_task(
    self,
    task_id: "capo_iot.types.mitigation_actions_task_id.MitigationActionsTaskId",
    target: "capo_iot.types.detect_mitigation_actions_task_target.DetectMitigationActionsTaskTarget",
    actions: "capo_iot.types.detect_mitigation_actions_to_execute_list.DetectMitigationActionsToExecuteList",
    client_request_token: "capo_iot.types.client_request_token.ClientRequestToken",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    violation_event_occurrence_range: Optional[
        "capo_iot.types.violation_event_occurrence_range.ViolationEventOccurrenceRange"
    ] = None,
    include_only_active_violations: Optional[
        "capo_iot.types.nullable_boolean.NullableBoolean"
    ] = None,
    include_suppressed_alerts: Optional[
        "capo_iot.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_iot.types.start_detect_mitigation_actions_task_response.StartDetectMitigationActionsTaskResponse":
    """<note> <p>The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.</p> </note> <p> Starts a Device Defender ML Detect mitigation actions task. </p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartDetectMitigationActionsTask</a> action.</p>

    Args:
        task_id: <p> The unique identifier of the task. </p>
        target: <p> Specifies the ML Detect findings to which the mitigation actions are applied. </p>
        actions: <p> The actions to be performed when a device has unexpected behavior. </p>
        violation_event_occurrence_range: <p> Specifies the time period of which violation events occurred between. </p>
        include_only_active_violations: <p> Specifies to list only active violations. </p>
        include_suppressed_alerts: <p> Specifies to include suppressed alerts. </p>
        client_request_token: <p> Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. </p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.limit_exceeded_exception.LimitExceededException: <p>A limit has been exceeded.</p>
        capo_iot.errors.task_already_exists_exception.TaskAlreadyExistsException: <p> This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken. </p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.start_detect_mitigation_actions_task_request.StartDetectMitigationActionsTaskRequest]",
    ) -> OperationResponse[
        "capo_iot.types.start_detect_mitigation_actions_task_response.StartDetectMitigationActionsTaskResponse"
    ]:
        import capo_iot._operations.aws_iot_service.start_detect_mitigation_actions_task

        output, http_response = (
            capo_iot._operations.aws_iot_service.start_detect_mitigation_actions_task.start_detect_mitigation_actions_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartDetectMitigationActionsTask")
    )
    input_: capo_iot.types.start_detect_mitigation_actions_task_request.StartDetectMitigationActionsTaskRequest = {
        "task_id": task_id,
        "target": target,
        "actions": actions,
        "client_request_token": client_request_token,
    }
    if violation_event_occurrence_range is not None:
        input_["violation_event_occurrence_range"] = (
            violation_event_occurrence_range
        )
    if include_only_active_violations is not None:
        input_["include_only_active_violations"] = include_only_active_violations
    if include_suppressed_alerts is not None:
        input_["include_suppressed_alerts"] = include_suppressed_alerts

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output