sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ KinesisAnalyticsV2/ DescribeApplication.ts

import type * as SVC from "@distilled.cloud/aws/kinesis-analytics-v2";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Application } from "./Application.ts";

export interface DescribeApplicationRequest extends Omit<
  SVC.DescribeApplicationRequest,
  "ApplicationName"
> {}

/**
 * Runtime binding for `kinesisanalytics:DescribeApplication` — reads the
 * bound application's full detail (status, version, runtime environment,
 * configuration), the building block of ops automation that reacts to the
 * Flink job's lifecycle state.
 * ### Observing the Application
 * **Example:** Check whether the Flink job is running
 * ```typescript
 * const describeApplication = yield* AWS.KinesisAnalyticsV2.DescribeApplication(app);
 *
 * const { ApplicationDetail } = yield* describeApplication();
 * const running = ApplicationDetail.ApplicationStatus === "RUNNING";
 * ```
 *
 * @binding
 */
export interface DescribeApplication extends Binding.Service<
  DescribeApplication,
  "AWS.KinesisAnalyticsV2.DescribeApplication",
  <A extends Application>(
    application: A,
  ) => Effect.Effect<
    (
      request?: DescribeApplicationRequest,
    ) => Effect.Effect<SVC.DescribeApplicationResponse, SVC.DescribeApplicationError>
  >
> {}
export const DescribeApplication = Binding.Service<DescribeApplication>(
  "AWS.KinesisAnalyticsV2.DescribeApplication",
);