sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ FSx/ DescribeDataRepositoryTasks.ts

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

/**
 * Runtime binding for the `DescribeDataRepositoryTasks` operation (IAM
 * action `fsx:DescribeDataRepositoryTasks` on `*`).
 *
 * Lists Lustre data repository tasks — optionally filtered by
 * `file-system-id` or `task-lifecycle`, or by explicit `TaskIds` — from
 * inside a function runtime. Pairs with {@link CreateDataRepositoryTask} to
 * poll an export/import task until it reaches `SUCCEEDED`. Provide the
 * implementation with
 * `Effect.provide(AWS.FSx.DescribeDataRepositoryTasksHttp)`.
 * ### Data Repository Tasks
 * **Example:** Poll a task until it finishes
 * ```typescript
 * const describeDataRepositoryTasks =
 *   yield* AWS.FSx.DescribeDataRepositoryTasks();
 *
 * const response = yield* describeDataRepositoryTasks({
 *   TaskIds: [taskId],
 * });
 * yield* Effect.log(response.DataRepositoryTasks?.[0]?.Lifecycle);
 * ```
 *
 * @binding
 */
export interface DescribeDataRepositoryTasks extends Binding.Service<
  DescribeDataRepositoryTasks,
  "AWS.FSx.DescribeDataRepositoryTasks",
  () => Effect.Effect<
    (
      request?: fsx.DescribeDataRepositoryTasksRequest,
    ) => Effect.Effect<
      fsx.DescribeDataRepositoryTasksResponse,
      fsx.DescribeDataRepositoryTasksError
    >
  >
> {}
export const DescribeDataRepositoryTasks = Binding.Service<DescribeDataRepositoryTasks>(
  "AWS.FSx.DescribeDataRepositoryTasks",
);