sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ SSMIncidents/ ListTimelineEvents.ts

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

/**
 * Runtime binding for `ssm-incidents:ListTimelineEvents`.
 *
 * Lists the timeline events of an incident, with optional filters and sorting.
 * Timeline events live under runtime incident-record ARNs, so the deploy-time
 * grant is account-level (`Resource: "*"`).
 * Provide the implementation with
 * `Effect.provide(AWS.SSMIncidents.ListTimelineEventsHttp)`.
 * ### Timeline Events
 * **Example:** List An Incident's Timeline
 * ```typescript
 * // init
 * const listTimelineEvents = yield* AWS.SSMIncidents.ListTimelineEvents();
 *
 * // runtime
 * const { eventSummaries } = yield* listTimelineEvents({
 *   incidentRecordArn,
 *   sortBy: "EVENT_TIME",
 *   sortOrder: "DESCENDING",
 * });
 * ```
 *
 * @binding
 */
export interface ListTimelineEvents extends Binding.Service<
  ListTimelineEvents,
  "AWS.SSMIncidents.ListTimelineEvents",
  () => Effect.Effect<
    (
      request: incidents.ListTimelineEventsInput,
    ) => Effect.Effect<incidents.ListTimelineEventsOutput, incidents.ListTimelineEventsError>
  >
> {}
export const ListTimelineEvents = Binding.Service<ListTimelineEvents>(
  "AWS.SSMIncidents.ListTimelineEvents",
);