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

BedrockRuntimeService overview

Added in v1.0.0


Table of contents


constructors

makeBedrockRuntimeService

Signature

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

Added in v1.0.0

models

BedrockRuntimeService (class)

Signature

export declare class BedrockRuntimeService

Added in v1.0.0

BedrockRuntimeService$ (interface)

Signature

export interface BedrockRuntimeService$ {
  /**
   * @see {@link ApplyGuardrailCommand}
   */
  applyGuardrail(
    args: ApplyGuardrailCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ApplyGuardrailCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ConverseCommand}
   */
  converse(
    args: ConverseCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ConverseCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ModelError
    | ModelNotReadyError
    | ModelTimeoutError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ConverseStreamCommand}
   */
  converseStream(
    args: ConverseStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ConverseStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ModelError
    | ModelNotReadyError
    | ModelTimeoutError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CountTokensCommand}
   */
  countTokens(
    args: CountTokensCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CountTokensCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link GetAsyncInvokeCommand}
   */
  getAsyncInvoke(
    args: GetAsyncInvokeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAsyncInvokeCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link InvokeGuardrailChecksCommand}
   */
  invokeGuardrailChecks(
    args: InvokeGuardrailChecksCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InvokeGuardrailChecksCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link InvokeModelCommand}
   */
  invokeModel(
    args: InvokeModelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InvokeModelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ModelError
    | ModelNotReadyError
    | ModelTimeoutError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link InvokeModelWithBidirectionalStreamCommand}
   */
  invokeModelWithBidirectionalStream(
    args: InvokeModelWithBidirectionalStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InvokeModelWithBidirectionalStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ModelError
    | ModelNotReadyError
    | ModelStreamError
    | ModelTimeoutError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link InvokeModelWithResponseStreamCommand}
   */
  invokeModelWithResponseStream(
    args: InvokeModelWithResponseStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InvokeModelWithResponseStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | ModelError
    | ModelNotReadyError
    | ModelStreamError
    | ModelTimeoutError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ListAsyncInvokesCommand}
   */
  listAsyncInvokes(
    args: ListAsyncInvokesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAsyncInvokesCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ThrottlingError | ValidationError
  >

  listAsyncInvokesStream(
    args: ListAsyncInvokesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAsyncInvokesCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link StartAsyncInvokeCommand}
   */
  startAsyncInvoke(
    args: StartAsyncInvokeCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartAsyncInvokeCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ServiceUnavailableError
    | ThrottlingError
    | ValidationError
  >
}

Added in v1.0.0

utils

BedrockRuntimeService (namespace)

Added in v1.0.0

Config (interface)

Signature

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

Added in v1.0.0

Type (type alias)

Signature

export type Type = BedrockRuntimeService$

Added in v1.0.0