sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IoT/ DescribeEndpoint.ts

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

export interface DescribeEndpointRequest extends iot.DescribeEndpointRequest {}

/**
 * Runtime binding for the `DescribeEndpoint` operation (IAM action
 * `iot:DescribeEndpoint`, granted on `*`).
 *
 * Returns the account-specific IoT endpoint — pass
 * `endpointType: "iot:Data-ATS"` for the recommended ATS data endpoint that
 * devices and MQTT clients connect to. Provide the implementation with
 * `Effect.provide(AWS.IoT.DescribeEndpointHttp)`.
 * ### Endpoints
 * **Example:** Discover the ATS Data Endpoint
 * ```typescript
 * const describeEndpoint = yield* AWS.IoT.DescribeEndpoint();
 *
 * const { endpointAddress } = yield* describeEndpoint({
 *   endpointType: "iot:Data-ATS",
 * });
 * ```
 *
 * @binding
 */
export interface DescribeEndpoint extends Binding.Service<
  DescribeEndpoint,
  "AWS.IoT.DescribeEndpoint",
  () => Effect.Effect<
    (
      request?: DescribeEndpointRequest,
    ) => Effect.Effect<iot.DescribeEndpointResponse, iot.DescribeEndpointError>
  >
> {}

export const DescribeEndpoint = Binding.Service<DescribeEndpoint>("AWS.IoT.DescribeEndpoint");