sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Notifications/ ListChannels.ts

import type * as notifications from "@distilled.cloud/aws/notifications";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { NotificationConfiguration } from "./NotificationConfiguration.ts";

/**
 * Request for {@link ListChannels} — the bound configuration's ARN is
 * injected automatically.
 */
export interface ListChannelsRequest extends Omit<
  notifications.ListChannelsRequest,
  "notificationConfigurationArn"
> {}

/**
 * Runtime binding for `notifications:ListChannels`.
 *
 * List the delivery channel ARNs associated with a notification
 * configuration. Provide the implementation with
 * `Effect.provide(AWS.Notifications.ListChannelsHttp)`.
 * ### Reading Configuration Channels
 * **Example:** List a Configuration's Channels
 * ```typescript
 * // init — bind the operation to the configuration
 * const listChannels = yield* AWS.Notifications.ListChannels(config);
 *
 * // runtime
 * const result = yield* listChannels();
 * const channelArns = result.channels;
 * ```
 *
 * @binding
 */
export interface ListChannels extends Binding.Service<
  ListChannels,
  "AWS.Notifications.ListChannels",
  (
    configuration: NotificationConfiguration,
  ) => Effect.Effect<
    (
      request?: ListChannelsRequest,
    ) => Effect.Effect<notifications.ListChannelsResponse, notifications.ListChannelsError>
  >
> {}

export const ListChannels = Binding.Service<ListChannels>("AWS.Notifications.ListChannels");