sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudWatch/ DescribeAlarmsForMetric.ts

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

export interface DescribeAlarmsForMetricRequest extends cloudwatch.DescribeAlarmsForMetricInput {}

/**
 * Runtime binding for `cloudwatch:DescribeAlarmsForMetric` — find the
 * alarms watching a specific metric.
 *
 * Provide `CloudWatch.DescribeAlarmsForMetricHttp` on the hosting Lambda
 * Function to satisfy the requirement.
 * ### Reading Alarm State
 * **Example:** Find Alarms Watching a Metric
 * ```typescript
 * // init — grants cloudwatch:DescribeAlarmsForMetric
 * const describeAlarmsForMetric = yield* AWS.CloudWatch.DescribeAlarmsForMetric();
 *
 * // runtime
 * const result = yield* describeAlarmsForMetric({
 *   Namespace: "MyApp/Payments",
 *   MetricName: "PaymentProcessed",
 *   Statistic: "Sum",
 *   Period: 60,
 * });
 * const alarmNames = (result.MetricAlarms ?? []).map((a) => a.AlarmName);
 * ```
 *
 * @binding
 */
export interface DescribeAlarmsForMetric extends Binding.Service<
  DescribeAlarmsForMetric,
  "AWS.CloudWatch.DescribeAlarmsForMetric",
  () => Effect.Effect<
    (
      request: DescribeAlarmsForMetricRequest,
    ) => Effect.Effect<
      cloudwatch.DescribeAlarmsForMetricOutput,
      cloudwatch.DescribeAlarmsForMetricError
    >
  >
> {}

export const DescribeAlarmsForMetric = Binding.Service<DescribeAlarmsForMetric>(
  "AWS.CloudWatch.DescribeAlarmsForMetric",
);