sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudTrail/ ListInsightsMetricData.ts

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

/**
 * Runtime binding for `cloudtrail:ListInsightsMetricData`.
 *
 * An account-level operation (no resource argument) that reads the Insights
 * metric time series (API call rate / error rate) for a given event source
 * and event name — empty when Insights has recorded no anomalies. Provide
 * the implementation with
 * `Effect.provide(AWS.CloudTrail.ListInsightsMetricDataHttp)`.
 * ### Reading Insights Metrics
 * **Example:** Read API Call Rate Metrics
 * ```typescript
 * // init — account-level binding takes no resource
 * const listInsightsMetricData =
 *   yield* AWS.CloudTrail.ListInsightsMetricData();
 *
 * // runtime
 * const result = yield* listInsightsMetricData({
 *   EventSource: "s3.amazonaws.com",
 *   EventName: "PutObject",
 *   InsightType: "ApiCallRateInsight",
 * });
 * console.log(result.Timestamps?.length, result.Values?.length);
 * ```
 *
 * @binding
 */
export interface ListInsightsMetricData extends Binding.Service<
  ListInsightsMetricData,
  "AWS.CloudTrail.ListInsightsMetricData",
  () => Effect.Effect<
    (
      request: cloudtrail.ListInsightsMetricDataRequest,
    ) => Effect.Effect<
      cloudtrail.ListInsightsMetricDataResponse,
      cloudtrail.ListInsightsMetricDataError
    >
  >
> {}
export const ListInsightsMetricData = Binding.Service<ListInsightsMetricData>(
  "AWS.CloudTrail.ListInsightsMetricData",
);