Skip to main content Link Search Menu Expand Document (external link)

SchedulerService overview

Added in v1.0.0


Table of contents


constructors

makeSchedulerService

Signature

export declare const makeSchedulerService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

SchedulerService (class)

Signature

export declare class SchedulerService

Added in v1.0.0

SchedulerService$ (interface)

Signature

export interface SchedulerService$ {
  /**
   * @see {@link CreateScheduleCommand}
   */
  createSchedule(
    args: CreateScheduleCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateScheduleCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateScheduleGroupCommand}
   */
  createScheduleGroup(
    args: CreateScheduleGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateScheduleGroupCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DeleteScheduleCommand}
   */
  deleteSchedule(
    args: DeleteScheduleCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteScheduleCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DeleteScheduleGroupCommand}
   */
  deleteScheduleGroup(
    args: DeleteScheduleGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteScheduleGroupCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link GetScheduleCommand}
   */
  getSchedule(
    args: GetScheduleCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetScheduleCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link GetScheduleGroupCommand}
   */
  getScheduleGroup(
    args: GetScheduleGroupCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetScheduleGroupCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link ListScheduleGroupsCommand}
   */
  listScheduleGroups(
    args: ListScheduleGroupsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListScheduleGroupsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ThrottlingError | ValidationError
  >

  listScheduleGroupsStream(
    args: ListScheduleGroupsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListScheduleGroupsCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link ListSchedulesCommand}
   */
  listSchedules(
    args: ListSchedulesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListSchedulesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  listSchedulesStream(
    args: ListSchedulesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListSchedulesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link UpdateScheduleCommand}
   */
  updateSchedule(
    args: UpdateScheduleCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateScheduleCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >
}

Added in v1.0.0

utils

SchedulerService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<SchedulerClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = SchedulerService$

Added in v1.0.0