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

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

export interface ListManagedInsightRulesRequest extends cloudwatch.ListManagedInsightRulesInput {}

/**
 * Runtime binding for `cloudwatch:ListManagedInsightRules` — list the
 * managed Contributor Insights rules available for a given AWS resource
 * ARN.
 *
 * Provide `CloudWatch.ListManagedInsightRulesHttp` on the hosting Lambda
 * Function to satisfy the requirement.
 * ### Reading Insight Rules
 * **Example:** List Managed Rules for a Resource
 * ```typescript
 * // init — grants cloudwatch:ListManagedInsightRules
 * const listManagedInsightRules = yield* AWS.CloudWatch.ListManagedInsightRules();
 *
 * // runtime — only specific AWS resource types support managed rules;
 * // an unsupported ARN fails with the typed InvalidParameterValueException
 * const result = yield* listManagedInsightRules({
 *   ResourceARN: yield* table.tableArn,
 * });
 * const rules = result.ManagedRules ?? [];
 * ```
 *
 * @binding
 */
export interface ListManagedInsightRules extends Binding.Service<
  ListManagedInsightRules,
  "AWS.CloudWatch.ListManagedInsightRules",
  () => Effect.Effect<
    (
      request?: ListManagedInsightRulesRequest,
    ) => Effect.Effect<
      cloudwatch.ListManagedInsightRulesOutput,
      cloudwatch.ListManagedInsightRulesError
    >
  >
> {}

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