| 1 | import type * as NFW from "@distilled.cloud/aws/network-firewall"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | import type { Firewall } from "./Firewall.ts"; |
| 5 | |
| 6 | export interface DescribeFlowOperationRequest extends Omit< |
| 7 | NFW.DescribeFlowOperationRequest, |
| 8 | "FirewallArn" |
| 9 | > {} |
| 10 | |
| 11 | /** |
| 12 | * Runtime binding for `network-firewall:DescribeFlowOperation` — read the |
| 13 | * status and definition of a flow capture/flush operation running on the |
| 14 | * bound {@link Firewall}; the firewall ARN is injected automatically. |
| 15 | * |
| 16 | * Provide `NetworkFirewall.DescribeFlowOperationHttp` on the hosting Lambda |
| 17 | * Function to satisfy the requirement. |
| 18 | * ### Flow Operations |
| 19 | * **Example:** Poll a Flow Operation |
| 20 | * ```typescript |
| 21 | * // init — grants network-firewall:DescribeFlowOperation on the firewall |
| 22 | * const describeFlowOperation = |
| 23 | * yield* AWS.NetworkFirewall.DescribeFlowOperation(firewall); |
| 24 | * |
| 25 | * // runtime |
| 26 | * const { FlowOperationStatus } = yield* describeFlowOperation({ |
| 27 | * FlowOperationId: flowOperationId, |
| 28 | * }); |
| 29 | * ``` |
| 30 | * |
| 31 | * @binding |
| 32 | */ |
| 33 | export interface DescribeFlowOperation extends Binding.Service< |
| 34 | DescribeFlowOperation, |
| 35 | "AWS.NetworkFirewall.DescribeFlowOperation", |
| 36 | ( |
| 37 | firewall: Firewall, |
| 38 | ) => Effect.Effect< |
| 39 | ( |
| 40 | request: DescribeFlowOperationRequest, |
| 41 | ) => Effect.Effect< |
| 42 | NFW.DescribeFlowOperationResponse, |
| 43 | NFW.DescribeFlowOperationError |
| 44 | > |
| 45 | > |
| 46 | > {} |
| 47 | |
| 48 | export const DescribeFlowOperation = Binding.Service<DescribeFlowOperation>( |
| 49 | "AWS.NetworkFirewall.DescribeFlowOperation", |
| 50 | ); |