sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IoTFleetWise/ ListVehicles.ts

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

/**
 * Runtime binding for the `ListVehicles` operation (IAM action
 * `iotfleetwise:ListVehicles`), account-level.
 *
 * Lists the vehicles in the account, optionally filtered by model
 * manifest or attribute values. Provide the implementation with
 * `Effect.provide(AWS.IoTFleetWise.ListVehiclesHttp)`.
 *
 * ### Provisioning Vehicles
 * **Example:** List Vehicles by Attribute
 * ```typescript
 * const listVehicles = yield* IoTFleetWise.ListVehicles();
 *
 * const { vehicleSummaries } = yield* listVehicles({
 *   attributeNames: ["Vehicle.Color"],
 *   attributeValues: ["red"],
 * });
 * ```
 *
 * @binding
 */
export interface ListVehicles extends Binding.Service<
  ListVehicles,
  "AWS.IoTFleetWise.ListVehicles",
  () => Effect.Effect<
    (
      request?: iotfleetwise.ListVehiclesRequest,
    ) => Effect.Effect<iotfleetwise.ListVehiclesResponse, iotfleetwise.ListVehiclesError>
  >
> {}
export const ListVehicles = Binding.Service<ListVehicles>("AWS.IoTFleetWise.ListVehicles");