sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DataExchange/ StartJob.ts

import type * as dataexchange from "@distilled.cloud/aws/dataexchange";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `dataexchange:StartJob`.
 *
 * Starts a created job. Jobs are created in the `WAITING` state and do
 * nothing until started. The job runs with the caller's forwarded
 * permissions, so this binding also grants `dataexchange:CreateAsset`
 * (import jobs) and `dataexchange:GetAsset` (export jobs); grant the S3
 * side of the transfer via the matching `AWS.S3` bindings.
 * Provide the implementation with
 * `Effect.provide(AWS.DataExchange.StartJobHttp)`.
 * ### Import & Export Jobs
 * **Example:** Start A Created Job
 * ```typescript
 * const startJob = yield* AWS.DataExchange.StartJob();
 *
 * // runtime
 * yield* startJob({ JobId: job.Id! });
 * ```
 *
 * @binding
 */
export interface StartJob extends Binding.Service<
  StartJob,
  "AWS.DataExchange.StartJob",
  () => Effect.Effect<
    (
      request: dataexchange.StartJobRequest,
    ) => Effect.Effect<dataexchange.StartJobResponse, dataexchange.StartJobError>
  >
> {}
export const StartJob = Binding.Service<StartJob>("AWS.DataExchange.StartJob");