sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Organizations/ DescribeOrganization.ts

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

/**
 * Runtime binding for `organizations:DescribeOrganization`.
 *
 * Retrieves information about the organization that the calling account belongs to — its id, ARN, feature set, and management account. Available from any account in the organization.
 * Account-level operation — Organizations is a management-account-scoped
 * global service, so the binding takes no resource argument. Provide the
 * implementation with `Effect.provide(AWS.Organizations.DescribeOrganizationHttp)`.
 * ### Reading the Organization Tree
 * **Example:** Read the Organization
 * ```typescript
 * // init — account-level binding, no resource argument
 * const describeOrganization = yield* AWS.Organizations.DescribeOrganization();
 *
 * // runtime
 * const { Organization } = yield* describeOrganization();
 * console.log(Organization?.Id, Organization?.MasterAccountId);
 * ```
 *
 * @binding
 */
export interface DescribeOrganization extends Binding.Service<
  DescribeOrganization,
  "AWS.Organizations.DescribeOrganization",
  () => Effect.Effect<
    (
      request?: organizations.DescribeOrganizationRequest,
    ) => Effect.Effect<
      organizations.DescribeOrganizationResponse,
      organizations.DescribeOrganizationError
    >
  >
> {}
export const DescribeOrganization = Binding.Service<DescribeOrganization>(
  "AWS.Organizations.DescribeOrganization",
);