sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ApplicationSignals/ ListServiceLevelObjectiveExclusionWindows.ts

import type * as appsignals from "@distilled.cloud/aws/application-signals";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { ServiceLevelObjective } from "./ServiceLevelObjective.ts";

/**
 * `ListServiceLevelObjectiveExclusionWindows` request with `Id` injected
 * from the bound {@link ServiceLevelObjective}.
 */
export interface ListExclusionWindowsRequest extends Omit<
  appsignals.ListServiceLevelObjectiveExclusionWindowsInput,
  "Id"
> {}

/**
 * Runtime binding for
 * `application-signals:ListServiceLevelObjectiveExclusionWindows`, scoped
 * to one {@link ServiceLevelObjective}.
 *
 * Lists the exclusion (maintenance) windows configured on the bound SLO.
 * Provide the implementation with
 * `Effect.provide(AWS.ApplicationSignals.ListServiceLevelObjectiveExclusionWindowsHttp)`.
 * ### Managing Exclusion Windows
 * **Example:** List the SLO's Exclusion Windows
 * ```typescript
 * // init — bind the operation to the SLO
 * const listExclusionWindows =
 *   yield* AWS.ApplicationSignals.ListServiceLevelObjectiveExclusionWindows(slo);
 *
 * // runtime — the SLO's ARN is injected as Id
 * const page = yield* listExclusionWindows();
 * yield* Effect.log(`${page.ExclusionWindows.length} windows`);
 * ```
 *
 * @binding
 */
export interface ListServiceLevelObjectiveExclusionWindows extends Binding.Service<
  ListServiceLevelObjectiveExclusionWindows,
  "AWS.ApplicationSignals.ListServiceLevelObjectiveExclusionWindows",
  (
    slo: ServiceLevelObjective,
  ) => Effect.Effect<
    (
      request?: ListExclusionWindowsRequest,
    ) => Effect.Effect<
      appsignals.ListServiceLevelObjectiveExclusionWindowsOutput,
      appsignals.ListServiceLevelObjectiveExclusionWindowsError
    >
  >
> {}

export const ListServiceLevelObjectiveExclusionWindows =
  Binding.Service<ListServiceLevelObjectiveExclusionWindows>(
    "AWS.ApplicationSignals.ListServiceLevelObjectiveExclusionWindows",
  );