| 1 | import type * as iotdata from "@distilled.cloud/aws/iot-data-plane"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | import type { Thing } from "./Thing.ts"; |
| 5 | |
| 6 | export interface DeleteThingShadowRequest extends Omit< |
| 7 | iotdata.DeleteThingShadowRequest, |
| 8 | "thingName" |
| 9 | > {} |
| 10 | |
| 11 | /** |
| 12 | * Runtime binding for the IoT data-plane `DeleteThingShadow` operation (IAM |
| 13 | * action `iot:DeleteThingShadow`). |
| 14 | * |
| 15 | * Bind it to a {@link Thing} to delete the thing's device shadow — the thing |
| 16 | * name is injected automatically. Provide the implementation with |
| 17 | * `Effect.provide(AWS.IoT.DeleteThingShadowHttp)`. |
| 18 | * ### Device Shadows |
| 19 | * **Example:** Delete a Named Shadow |
| 20 | * ```typescript |
| 21 | * const deleteShadow = yield* AWS.IoT.DeleteThingShadow(thing); |
| 22 | * |
| 23 | * yield* deleteShadow({ shadowName: "telemetry" }); |
| 24 | * ``` |
| 25 | * |
| 26 | * @binding |
| 27 | */ |
| 28 | export interface DeleteThingShadow extends Binding.Service< |
| 29 | DeleteThingShadow, |
| 30 | "AWS.IoT.DeleteThingShadow", |
| 31 | ( |
| 32 | thing: Thing, |
| 33 | ) => Effect.Effect< |
| 34 | ( |
| 35 | request?: DeleteThingShadowRequest, |
| 36 | ) => Effect.Effect< |
| 37 | iotdata.DeleteThingShadowResponse, |
| 38 | iotdata.DeleteThingShadowError |
| 39 | > |
| 40 | > |
| 41 | > {} |
| 42 | |
| 43 | export const DeleteThingShadow = Binding.Service<DeleteThingShadow>( |
| 44 | "AWS.IoT.DeleteThingShadow", |
| 45 | ); |