| 1 | import type * as SVC from "@distilled.cloud/aws/finspace"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | import type { KxEnvironment } from "./KxEnvironment.ts"; |
| 5 | |
| 6 | /** |
| 7 | * Runtime binding for `finspace:ListKxVolumes` — lists the volumes of the bound environment, optionally filtered by volume type. |
| 8 | * Provide the implementation with |
| 9 | * `Effect.provide(AWS.FinSpace.ListKxVolumesHttp)`. |
| 10 | * ### Managing Volumes |
| 11 | * **Example:** List NAS_1 Volumes |
| 12 | * ```typescript |
| 13 | * const listVolumes = yield* AWS.FinSpace.ListKxVolumes(kdb); |
| 14 | * |
| 15 | * const { kxVolumeSummaries } = yield* listVolumes({ volumeType: "NAS_1" }); |
| 16 | * ``` |
| 17 | * |
| 18 | * @binding |
| 19 | */ |
| 20 | export interface ListKxVolumes extends Binding.Service< |
| 21 | ListKxVolumes, |
| 22 | "AWS.FinSpace.ListKxVolumes", |
| 23 | <K extends KxEnvironment>( |
| 24 | environment: K, |
| 25 | ) => Effect.Effect< |
| 26 | ( |
| 27 | request?: Omit<SVC.ListKxVolumesRequest, "environmentId">, |
| 28 | ) => Effect.Effect<SVC.ListKxVolumesResponse, SVC.ListKxVolumesError> |
| 29 | > |
| 30 | > {} |
| 31 | export const ListKxVolumes = Binding.Service<ListKxVolumes>( |
| 32 | "AWS.FinSpace.ListKxVolumes", |
| 33 | ); |