sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IoTManagedIntegrations/ GetDeviceDiscovery.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";

/**
 * Request for {@link GetDeviceDiscovery}.
 */
export interface GetDeviceDiscoveryRequest extends mi.GetDeviceDiscoveryRequest {}

/**
 * Runtime binding for `iotmanagedintegrations:GetDeviceDiscovery`
 * (account-level).
 *
 * Reads the status of a discovery scan started with
 * {@link StartDeviceDiscovery}. Provide the implementation with
 * `Effect.provide(AWS.IoTManagedIntegrations.GetDeviceDiscoveryHttp)`.
 *
 * ### Discovering Devices
 * **Example:** Poll a Discovery Scan
 * ```typescript
 * const getDiscovery = yield* IoTManagedIntegrations.GetDeviceDiscovery();
 *
 * const { Status } = yield* getDiscovery({ Identifier: discoveryId });
 * ```
 *
 * @binding
 */
export interface GetDeviceDiscovery extends Binding.Service<
  GetDeviceDiscovery,
  "AWS.IoTManagedIntegrations.GetDeviceDiscovery",
  () => Effect.Effect<
    (
      request: GetDeviceDiscoveryRequest,
    ) => Effect.Effect<mi.GetDeviceDiscoveryResponse, mi.GetDeviceDiscoveryError>
  >
> {}
export const GetDeviceDiscovery = Binding.Service<GetDeviceDiscovery>(
  "AWS.IoTManagedIntegrations.GetDeviceDiscovery",
);