sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DMS/ DescribeEndpointSettings.ts

import type * as dms from "@distilled.cloud/aws/database-migration-service";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `dms:DescribeEndpointSettings`.
 *
 * Bind this operation (account-level) to enumerate the settings an endpoint
 * engine supports — names, types, enum values, defaults — e.g. to validate
 * user-supplied endpoint configuration before creating endpoints. Provide
 * the implementation with
 * `Effect.provide(AWS.DMS.DescribeEndpointSettingsHttp)`.
 * ### Inspecting Engine Settings
 * **Example:** List the Settings MySQL Endpoints Accept
 * ```typescript
 * // init — account-level, no target resource
 * const endpointSettings = yield* AWS.DMS.DescribeEndpointSettings();
 *
 * // runtime
 * const { EndpointSettings } = yield* endpointSettings({
 *   EngineName: "mysql",
 * });
 * ```
 *
 * @binding
 */
export interface DescribeEndpointSettings extends Binding.Service<
  DescribeEndpointSettings,
  "AWS.DMS.DescribeEndpointSettings",
  () => Effect.Effect<
    (
      request: dms.DescribeEndpointSettingsMessage,
    ) => Effect.Effect<dms.DescribeEndpointSettingsResponse, dms.DescribeEndpointSettingsError>
  >
> {}

export const DescribeEndpointSettings = Binding.Service<DescribeEndpointSettings>(
  "AWS.DMS.DescribeEndpointSettings",
);