| 1 | import type * as ssm from "@distilled.cloud/aws/ssm-contacts"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | |
| 5 | /** |
| 6 | * Runtime binding for `ssm-contacts:StopEngagement`. |
| 7 | * |
| 8 | * Stop a running engagement, halting any further stages of the contact's |
| 9 | * engagement plan — e.g. once the incident is acknowledged or resolved. |
| 10 | * Engagement ARNs are minted at runtime by `StartEngagement`, so this |
| 11 | * binding is account-scoped. |
| 12 | * Provide the implementation with |
| 13 | * `Effect.provide(AWS.SSMContacts.StopEngagementHttp)`. |
| 14 | * ### Managing Engagements |
| 15 | * **Example:** Stop an Engagement After Resolution |
| 16 | * ```typescript |
| 17 | * const stopEngagement = yield* AWS.SSMContacts.StopEngagement(); |
| 18 | * |
| 19 | * yield* stopEngagement({ |
| 20 | * EngagementId: engagementArn, |
| 21 | * Reason: "incident resolved", |
| 22 | * }); |
| 23 | * ``` |
| 24 | * |
| 25 | * @binding |
| 26 | */ |
| 27 | export interface StopEngagement extends Binding.Service< |
| 28 | StopEngagement, |
| 29 | "AWS.SSMContacts.StopEngagement", |
| 30 | () => Effect.Effect< |
| 31 | ( |
| 32 | request: ssm.StopEngagementRequest, |
| 33 | ) => Effect.Effect<ssm.StopEngagementResult, ssm.StopEngagementError> |
| 34 | > |
| 35 | > {} |
| 36 | export const StopEngagement = Binding.Service<StopEngagement>( |
| 37 | "AWS.SSMContacts.StopEngagement", |
| 38 | ); |