sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Backup/ DescribeBackupJob.ts

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

/**
 * Runtime binding for the `DescribeBackupJob` operation (IAM action
 * `backup:DescribeBackupJob`).
 *
 * Returns the details of a backup job by its ID — poll a job started with
 * `StartBackupJob` until it completes. Provide the implementation with
 * `Effect.provide(AWS.Backup.DescribeBackupJobHttp)`.
 * ### Monitoring Backup Jobs
 * **Example:** Poll A Backup Job
 * ```typescript
 * const describeBackupJob = yield* AWS.Backup.DescribeBackupJob();
 *
 * const job = yield* describeBackupJob({ BackupJobId: jobId });
 * if (job.State === "COMPLETED") {
 *   yield* Effect.log(`recovery point: ${job.RecoveryPointArn}`);
 * }
 * ```
 *
 * @binding
 */
export interface DescribeBackupJob extends Binding.Service<
  DescribeBackupJob,
  "AWS.Backup.DescribeBackupJob",
  () => Effect.Effect<
    (
      request: backup.DescribeBackupJobInput,
    ) => Effect.Effect<backup.DescribeBackupJobOutput, backup.DescribeBackupJobError>
  >
> {}
export const DescribeBackupJob = Binding.Service<DescribeBackupJob>("AWS.Backup.DescribeBackupJob");