sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DataSync/ CancelTaskExecution.ts

import type * as datasync from "@distilled.cloud/aws/datasync";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Task } from "./Task.ts";

/**
 * Runtime binding for `datasync:CancelTaskExecution`.
 *
 * Stops a queued or in-flight execution of the bound {@link Task} — e.g. a
 * kill switch when a transfer was started by mistake or is saturating a
 * link. Address the execution with the ARN returned by
 * `StartTaskExecution`; access is granted on the bound task's executions.
 * Provide the implementation with
 * `Effect.provide(AWS.DataSync.CancelTaskExecutionHttp)`.
 * ### Running Transfers
 * **Example:** Cancel A Transfer
 * ```typescript
 * // init — bind the operation to the task
 * const cancelTaskExecution = yield* AWS.DataSync.CancelTaskExecution(task);
 *
 * // runtime
 * yield* cancelTaskExecution({ TaskExecutionArn: executionArn });
 * ```
 *
 * @binding
 */
export interface CancelTaskExecution extends Binding.Service<
  CancelTaskExecution,
  "AWS.DataSync.CancelTaskExecution",
  (
    task: Task,
  ) => Effect.Effect<
    (
      request: datasync.CancelTaskExecutionRequest,
    ) => Effect.Effect<datasync.CancelTaskExecutionResponse, datasync.CancelTaskExecutionError>
  >
> {}
export const CancelTaskExecution = Binding.Service<CancelTaskExecution>(
  "AWS.DataSync.CancelTaskExecution",
);