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

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

export interface DescribeAlarmHistoryRequest extends cloudwatch.DescribeAlarmHistoryInput {}

/**
 * Runtime binding for `cloudwatch:DescribeAlarmHistory` — read state
 * transitions and configuration changes recorded for alarms in the
 * account/region.
 *
 * Provide `CloudWatch.DescribeAlarmHistoryHttp` on the hosting Lambda
 * Function to satisfy the requirement.
 * ### Reading Alarm State
 * **Example:** Read an Alarm's Recent History
 * ```typescript
 * // init — grants cloudwatch:DescribeAlarmHistory
 * const describeAlarmHistory = yield* AWS.CloudWatch.DescribeAlarmHistory();
 *
 * // runtime
 * const result = yield* describeAlarmHistory({
 *   AlarmName: yield* alarm.alarmName,
 *   MaxRecords: 10,
 * });
 * const items = result.AlarmHistoryItems ?? [];
 * ```
 *
 * @binding
 */
export interface DescribeAlarmHistory extends Binding.Service<
  DescribeAlarmHistory,
  "AWS.CloudWatch.DescribeAlarmHistory",
  () => Effect.Effect<
    (
      request?: DescribeAlarmHistoryRequest,
    ) => Effect.Effect<cloudwatch.DescribeAlarmHistoryOutput, cloudwatch.DescribeAlarmHistoryError>
  >
> {}

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