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

TextractService overview

Added in v1.0.0


Table of contents


constructors

makeTextractService

Signature

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

Added in v1.0.0

models

TextractService (class)

Signature

export declare class TextractService

Added in v1.0.0

TextractService$ (interface)

Signature

export interface TextractService$ {
  /**
   * @see {@link AnalyzeDocumentCommand}
   */
  analyzeDocument(
    args: AnalyzeDocumentCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AnalyzeDocumentCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | HumanLoopQuotaExceededError
    | InternalServerError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link AnalyzeExpenseCommand}
   */
  analyzeExpense(
    args: AnalyzeExpenseCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AnalyzeExpenseCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | InternalServerError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link AnalyzeIDCommand}
   */
  analyzeID(
    args: AnalyzeIDCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    AnalyzeIDCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | InternalServerError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link CreateAdapterCommand}
   */
  createAdapter(
    args: CreateAdapterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateAdapterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidParameterError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateAdapterVersionCommand}
   */
  createAdapterVersion(
    args: CreateAdapterVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateAdapterVersionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DeleteAdapterCommand}
   */
  deleteAdapter(
    args: DeleteAdapterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAdapterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DeleteAdapterVersionCommand}
   */
  deleteAdapterVersion(
    args: DeleteAdapterVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAdapterVersionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link DetectDocumentTextCommand}
   */
  detectDocumentText(
    args: DetectDocumentTextCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DetectDocumentTextCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | InternalServerError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link GetAdapterCommand}
   */
  getAdapter(
    args: GetAdapterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAdapterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link GetAdapterVersionCommand}
   */
  getAdapterVersion(
    args: GetAdapterVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAdapterVersionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link GetDocumentAnalysisCommand}
   */
  getDocumentAnalysis(
    args: GetDocumentAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDocumentAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidJobIdError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
  >

  /**
   * @see {@link GetDocumentTextDetectionCommand}
   */
  getDocumentTextDetection(
    args: GetDocumentTextDetectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetDocumentTextDetectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidJobIdError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
  >

  /**
   * @see {@link GetExpenseAnalysisCommand}
   */
  getExpenseAnalysis(
    args: GetExpenseAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetExpenseAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidJobIdError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
  >

  /**
   * @see {@link GetLendingAnalysisCommand}
   */
  getLendingAnalysis(
    args: GetLendingAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetLendingAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidJobIdError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
  >

  /**
   * @see {@link GetLendingAnalysisSummaryCommand}
   */
  getLendingAnalysisSummary(
    args: GetLendingAnalysisSummaryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetLendingAnalysisSummaryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidJobIdError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | ProvisionedThroughputExceededError
    | ThrottlingError
  >

  /**
   * @see {@link ListAdapterVersionsCommand}
   */
  listAdapterVersions(
    args: ListAdapterVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAdapterVersionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  listAdapterVersionsStream(
    args: ListAdapterVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAdapterVersionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ListAdaptersCommand}
   */
  listAdapters(
    args: ListAdaptersCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAdaptersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | ValidationError
  >

  listAdaptersStream(
    args: ListAdaptersCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAdaptersCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | ValidationError
  >

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

  /**
   * @see {@link StartDocumentAnalysisCommand}
   */
  startDocumentAnalysis(
    args: StartDocumentAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartDocumentAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link StartDocumentTextDetectionCommand}
   */
  startDocumentTextDetection(
    args: StartDocumentTextDetectionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartDocumentTextDetectionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link StartExpenseAnalysisCommand}
   */
  startExpenseAnalysis(
    args: StartExpenseAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartExpenseAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

  /**
   * @see {@link StartLendingAnalysisCommand}
   */
  startLendingAnalysis(
    args: StartLendingAnalysisCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartLendingAnalysisCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | BadDocumentError
    | DocumentTooLargeError
    | IdempotentParameterMismatchError
    | InternalServerError
    | InvalidKMSKeyError
    | InvalidParameterError
    | InvalidS3ObjectError
    | LimitExceededError
    | ProvisionedThroughputExceededError
    | ThrottlingError
    | UnsupportedDocumentError
  >

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

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

  /**
   * @see {@link UpdateAdapterCommand}
   */
  updateAdapter(
    args: UpdateAdapterCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAdapterCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | InvalidParameterError
    | ProvisionedThroughputExceededError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >
}

Added in v1.0.0

utils

TextractService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = TextractService$

Added in v1.0.0