sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ SecurityHub/ GetSecurityControlDefinition.ts

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

/**
 * Runtime binding for `securityhub:GetSecurityControlDefinition`.
 *
 * Returns the definition (title, description, parameters, severity) of a single security control.
 * Account-level operation — invoked with the caller's request as-is.
 * Provide the implementation with
 * `Effect.provide(AWS.SecurityHub.GetSecurityControlDefinitionHttp)`.
 * ### Standards & Controls
 * **Example:** Read a Control Definition
 * ```typescript
 * // init — account-level binding, no resource argument
 * const getSecurityControlDefinition = yield* AWS.SecurityHub.GetSecurityControlDefinition();
 *
 * // runtime
 * const { SecurityControlDefinition } = yield* getSecurityControlDefinition({
 *   SecurityControlId: "IAM.1",
 * });
 * ```
 *
 * @binding
 */
export interface GetSecurityControlDefinition extends Binding.Service<
  GetSecurityControlDefinition,
  "AWS.SecurityHub.GetSecurityControlDefinition",
  () => Effect.Effect<
    (
      request?: securityhub.GetSecurityControlDefinitionRequest,
    ) => Effect.Effect<
      securityhub.GetSecurityControlDefinitionResponse,
      securityhub.GetSecurityControlDefinitionError
    >
  >
> {}
export const GetSecurityControlDefinition = Binding.Service<GetSecurityControlDefinition>(
  "AWS.SecurityHub.GetSecurityControlDefinition",
);