sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OpenSearch/ StartDomainMaintenance.ts

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

/**
 * Runtime binding for the `StartDomainMaintenance` operation (IAM action
 * `es:StartDomainMaintenance`).
 *
 * Starts a maintenance action on a domain — reboot a node, restart the search process, or restart Dashboards — e.g. remediation triggered by a health alarm. Provide the implementation with
 * `Effect.provide(AWS.OpenSearch.StartDomainMaintenanceHttp)`.
 * ### Domain Maintenance
 * **Example:** Reboot a Data Node
 * ```typescript
 * const startDomainMaintenance = yield* OpenSearch.StartDomainMaintenance();
 *
 * const result = yield* startDomainMaintenance({
 *   DomainName: name,
 *   Action: "REBOOT_NODE",
 *   NodeId: nodeId,
 * });
 * // result.MaintenanceId → track with GetDomainMaintenanceStatus
 * ```
 *
 * @binding
 */
export interface StartDomainMaintenance extends Binding.Service<
  StartDomainMaintenance,
  "AWS.OpenSearch.StartDomainMaintenance",
  () => Effect.Effect<
    (
      request: opensearch.StartDomainMaintenanceRequest,
    ) => Effect.Effect<
      opensearch.StartDomainMaintenanceResponse,
      opensearch.StartDomainMaintenanceError
    >
  >
> {}
export const StartDomainMaintenance = Binding.Service<StartDomainMaintenance>(
  "AWS.OpenSearch.StartDomainMaintenance",
);