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

DataPipelineService overview

Added in v1.0.0


Table of contents


constructors

makeDataPipelineService

Signature

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

Added in v1.0.0

models

DataPipelineService (class)

Signature

export declare class DataPipelineService

Added in v1.0.0

DataPipelineService$ (interface)

Signature

export interface DataPipelineService$ {
  /**
   * @see {@link ActivatePipelineCommand}
   */
  activatePipeline(
    args: ActivatePipelineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ActivatePipelineCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link AddTagsCommand}
   */
  addTags(
    args: AddTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AddTagsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link CreatePipelineCommand}
   */
  createPipeline(
    args: CreatePipelineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreatePipelineCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError
  >

  /**
   * @see {@link DeactivatePipelineCommand}
   */
  deactivatePipeline(
    args: DeactivatePipelineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeactivatePipelineCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link DeletePipelineCommand}
   */
  deletePipeline(
    args: DeletePipelineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeletePipelineCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError | PipelineNotFoundError
  >

  /**
   * @see {@link DescribeObjectsCommand}
   */
  describeObjects(
    args: DescribeObjectsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeObjectsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  describeObjectsStream(
    args: DescribeObjectsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeObjectsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link DescribePipelinesCommand}
   */
  describePipelines(
    args: DescribePipelinesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribePipelinesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link EvaluateExpressionCommand}
   */
  evaluateExpression(
    args: EvaluateExpressionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    EvaluateExpressionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
    | TaskNotFoundError
  >

  /**
   * @see {@link GetPipelineDefinitionCommand}
   */
  getPipelineDefinition(
    args: GetPipelineDefinitionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPipelineDefinitionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link ListPipelinesCommand}
   */
  listPipelines(
    args: ListPipelinesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListPipelinesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError
  >

  listPipelinesStream(
    args: ListPipelinesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListPipelinesCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError
  >

  /**
   * @see {@link PollForTaskCommand}
   */
  pollForTask(
    args: PollForTaskCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PollForTaskCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError | TaskNotFoundError
  >

  /**
   * @see {@link PutPipelineDefinitionCommand}
   */
  putPipelineDefinition(
    args: PutPipelineDefinitionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutPipelineDefinitionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link QueryObjectsCommand}
   */
  queryObjects(
    args: QueryObjectsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    QueryObjectsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  queryObjectsStream(
    args: QueryObjectsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    QueryObjectsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link RemoveTagsCommand}
   */
  removeTags(
    args: RemoveTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RemoveTagsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link ReportTaskProgressCommand}
   */
  reportTaskProgress(
    args: ReportTaskProgressCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ReportTaskProgressCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
    | TaskNotFoundError
  >

  /**
   * @see {@link ReportTaskRunnerHeartbeatCommand}
   */
  reportTaskRunnerHeartbeat(
    args: ReportTaskRunnerHeartbeatCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ReportTaskRunnerHeartbeatCommandOutput,
    Cause.TimeoutError | SdkError | InternalServiceError | InvalidRequestError
  >

  /**
   * @see {@link SetStatusCommand}
   */
  setStatus(
    args: SetStatusCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SetStatusCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >

  /**
   * @see {@link SetTaskStatusCommand}
   */
  setTaskStatus(
    args: SetTaskStatusCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SetTaskStatusCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
    | TaskNotFoundError
  >

  /**
   * @see {@link ValidatePipelineDefinitionCommand}
   */
  validatePipelineDefinition(
    args: ValidatePipelineDefinitionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ValidatePipelineDefinitionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InternalServiceError
    | InvalidRequestError
    | PipelineDeletedError
    | PipelineNotFoundError
  >
}

Added in v1.0.0

utils

DataPipelineService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = DataPipelineService$

Added in v1.0.0