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

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

/**
 * `ListDecoderManifestSignals` request with `name` injected from the bound
 * decoder manifest.
 */
export interface ListDecoderManifestSignalsRequest extends Omit<
  iotfleetwise.ListDecoderManifestSignalsRequest,
  "name"
> {}

/**
 * Runtime binding for the `ListDecoderManifestSignals` operation (IAM
 * action `iotfleetwise:ListDecoderManifestSignals`), scoped to one
 * {@link DecoderManifest}.
 *
 * Lists the signal decoders (CAN/OBD/message decoding rules) defined in
 * the bound decoder manifest. Provide the implementation with
 * `Effect.provide(AWS.IoTFleetWise.ListDecoderManifestSignalsHttp)`.
 *
 * ### Inspecting Signal Definitions
 * **Example:** List a Decoder's Signal Decoders
 * ```typescript
 * const listDecoderSignals =
 *   yield* IoTFleetWise.ListDecoderManifestSignals(decoder);
 *
 * const { signalDecoders } = yield* listDecoderSignals();
 * ```
 *
 * @binding
 */
export interface ListDecoderManifestSignals extends Binding.Service<
  ListDecoderManifestSignals,
  "AWS.IoTFleetWise.ListDecoderManifestSignals",
  (
    decoder: DecoderManifest,
  ) => Effect.Effect<
    (
      request?: ListDecoderManifestSignalsRequest,
    ) => Effect.Effect<
      iotfleetwise.ListDecoderManifestSignalsResponse,
      iotfleetwise.ListDecoderManifestSignalsError
    >
  >
> {}
export const ListDecoderManifestSignals = Binding.Service<ListDecoderManifestSignals>(
  "AWS.IoTFleetWise.ListDecoderManifestSignals",
);