send_task_failure ¶

def send_task_failure(
    self,
    task_token: "capo_sfn.types.task_token.TaskToken",
    *,
    config_overrides: Optional[SFNClientConfig] = None,
    error: Optional["capo_sfn.types.sensitive_error.SensitiveError"] = None,
    cause: Optional["capo_sfn.types.sensitive_cause.SensitiveCause"] = None,
) -> "capo_sfn.types.send_task_failure_output.SendTaskFailureOutput":
    """<p>Used by activity workers, Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a> pattern, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <code>taskToken</code> failed.</p> <p>For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.</p> <p>A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both <code>error</code> and <code>cause</code> fields because no data needs to be encrypted.</p>

    Args:
        task_token: <p>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
        error: <p>The error code of the failure.</p>
        cause: <p>A more detailed explanation of the cause of the failure.</p>

    Raises:
        capo_sfn.errors.invalid_token.InvalidToken: <p>The provided token is not valid.</p>
        capo_sfn.errors.kms_access_denied_exception.KmsAccessDeniedException: <p>Either your KMS key policy or API caller does not have the required permissions.</p>
        capo_sfn.errors.kms_invalid_state_exception.KmsInvalidStateException: <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
        capo_sfn.errors.kms_throttling_exception.KmsThrottlingException: <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
        capo_sfn.errors.task_does_not_exist.TaskDoesNotExist: <p>The activity does not exist.</p>
        capo_sfn.errors.task_timed_out.TaskTimedOut: <p>The task token has either expired or the task associated with the token has already been closed.</p>
        capo_sfn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sfn.types.send_task_failure_input.SendTaskFailureInput]",
    ) -> OperationResponse[
        "capo_sfn.types.send_task_failure_output.SendTaskFailureOutput"
    ]:
        import capo_sfn._operations.aws_step_functions.send_task_failure

        output, http_response = (
            capo_sfn._operations.aws_step_functions.send_task_failure.send_task_failure(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_sfn.types.send_task_failure_input.SendTaskFailureInput",
    ) -> dict[str, Any]:
        import capo_sfn.types.send_task_failure_input

        return capo_sfn.types.send_task_failure_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("SendTaskFailure", redact_input=_redact_input),
    )
    input_: capo_sfn.types.send_task_failure_input.SendTaskFailureInput = {
        "task_token": task_token
    }
    if error is not None:
        input_["error"] = error
    if cause is not None:
        input_["cause"] = cause

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