sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ QApps/ DescribeQAppPermissions.ts

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

/**
 * Request for {@link DescribeQAppPermissions} — `instanceId` and `appId` are injected from the bound Q App.
 */
export interface DescribeQAppPermissionsRequest extends Omit<
  qapps.DescribeQAppPermissionsInput,
  "instanceId" | "appId"
> {}

/**
 * Runtime binding for `qapps:DescribeQAppPermissions`.
 *
 * Reads the principals and actions granted on the bound Q App. Provide the implementation with
 * `Effect.provide(AWS.QApps.DescribeQAppPermissionsHttp)`.
 * ### Permissions
 * **Example:** Describe App Permissions
 * ```typescript
 * // init — bind the operation to the Q App
 * const describeQAppPermissions = yield* AWS.QApps.DescribeQAppPermissions(app);
 *
 * // runtime
 * const permissions = yield* describeQAppPermissions();
 * console.log(permissions.permissions?.length);
 * ```
 *
 * @binding
 */
export interface DescribeQAppPermissions extends Binding.Service<
  DescribeQAppPermissions,
  "AWS.QApps.DescribeQAppPermissions",
  (
    app: QApp,
  ) => Effect.Effect<
    (
      request?: DescribeQAppPermissionsRequest,
    ) => Effect.Effect<qapps.DescribeQAppPermissionsOutput, qapps.DescribeQAppPermissionsError>
  >
> {}

export const DescribeQAppPermissions = Binding.Service<DescribeQAppPermissions>(
  "AWS.QApps.DescribeQAppPermissions",
);