sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IoTManagedIntegrations/ GetManagedThingCapabilities.ts

import type * as mi from "@distilled.cloud/aws/iot-managed-integrations";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { ManagedThing } from "./ManagedThing.ts";

/**
 * Runtime binding for the `GetManagedThingCapabilities` operation (IAM
 * action `iotmanagedintegrations:GetManagedThingCapabilities`), scoped to
 * one {@link ManagedThing}.
 *
 * Reads the capability report the bound device registered at onboarding —
 * the data model that {@link SendManagedThingCommand} commands are written
 * against. Provide the implementation with
 * `Effect.provide(AWS.IoTManagedIntegrations.GetManagedThingCapabilitiesHttp)`.
 *
 * ### Reading Device State
 * **Example:** Inspect the Device Capability Report
 * ```typescript
 * const getCapabilities =
 *   yield* IoTManagedIntegrations.GetManagedThingCapabilities(thing);
 *
 * const { CapabilityReport } = yield* getCapabilities();
 * // CapabilityReport?.endpoints[0].capabilities
 * ```
 *
 * @binding
 */
export interface GetManagedThingCapabilities extends Binding.Service<
  GetManagedThingCapabilities,
  "AWS.IoTManagedIntegrations.GetManagedThingCapabilities",
  (
    thing: ManagedThing,
  ) => Effect.Effect<
    () => Effect.Effect<mi.GetManagedThingCapabilitiesResponse, mi.GetManagedThingCapabilitiesError>
  >
> {}
export const GetManagedThingCapabilities = Binding.Service<GetManagedThingCapabilities>(
  "AWS.IoTManagedIntegrations.GetManagedThingCapabilities",
);