Skip to content
Effect Days 2026 Get your ticket

AmazonBedrockSchema

70 exports Added in v1.0.0 Source

Models

Signature

type ConverseResponseStreamEvent = typeof ConverseResponseStreamEvent.Type

Schemas

The foundation models supported by Amazon Bedrock.

An up-to-date list can be generated with the following command:

Signature

declare class BedrockFoundationModelId extends {} {
constructor(_: never);
}

Example

Terminal window
aws bedrock list-foundation-models --output json | jq '[.modelSummaries[].modelId]'

Signature

declare class CachePointBlock extends {
readonly type: "default";
} {
constructor(...args: [props: {
readonly type: "default";
}, options?: MakeOptions]);
}

ContentBlock

Added in v1.0.0 Source

Signature

declare class ContentBlock extends {} {
constructor(_: never);
}

Signature

declare class ContentBlockDelta extends {} {
constructor(_: never);
}

Signature

declare class ContentBlockDeltaEvent extends {
readonly contentBlockIndex: unknown;
readonly delta: never;
} {
constructor(...args: [props: {
readonly contentBlockIndex: unknown;
readonly delta: never;
}, options?: MakeOptions]);
}

Signature

declare class ContentBlockStart extends {
readonly toolUse?: ToolUseBlockStart;
} {
constructor(...args: [props?: {
readonly toolUse?: ToolUseBlockStart;
}, options?: MakeOptions]);
}

Signature

declare class ContentBlockStartEvent extends {
readonly contentBlockIndex: unknown;
readonly start: ContentBlockStart;
} {
constructor(...args: [props: {
readonly contentBlockIndex: unknown;
readonly start: ContentBlockStart;
}, options?: MakeOptions]);
}

Signature

declare class ContentBlockStopEvent extends {
readonly contentBlockIndex: unknown;
} {
constructor(...args: [props: {
readonly contentBlockIndex: unknown;
}, options?: MakeOptions]);
}

Signature

declare class ConverseMetrics extends {
readonly latencyMs: Duration;
} {
constructor(...args: [props: {
readonly latencyMs: Duration;
}, options?: MakeOptions]);
}

Signature

declare class ConverseOutput extends {
readonly message: Message;
} {
constructor(...args: [props: {
readonly message: Message;
}, options?: MakeOptions]);
}

Signature

declare class ConverseRequest extends {
readonly additionalModelRequestFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly additionalModelResponseFieldPaths?: undefined;
readonly guardrailConfig?: GuardrailConfiguration;
readonly inferenceConfig?: InferenceConfiguration;
readonly messages: readonly Array<Message>;
readonly modelId: string;
readonly performanceConfig?: PerformanceConfiguration;
readonly promptVariables?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly requestMetadata?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly system?: readonly Array<unknown>;
readonly toolConfig?: ToolConfiguration;
} {
constructor(...args: [props: {
readonly additionalModelRequestFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly additionalModelResponseFieldPaths?: undefined;
readonly guardrailConfig?: GuardrailConfiguration;
readonly inferenceConfig?: InferenceConfiguration;
readonly messages: readonly Array<Message>;
readonly modelId: string;
readonly performanceConfig?: PerformanceConfiguration;
readonly promptVariables?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly requestMetadata?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly system?: readonly Array<unknown>;
readonly toolConfig?: ToolConfiguration;
}, options?: MakeOptions]);
}

Signature

declare class ConverseResponse extends {
readonly additionalModelResponseFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly metrics: ConverseMetrics;
readonly output: ConverseOutput;
readonly performanceConfig?: {
readonly latency: "standard";
};
readonly stopReason: "content_filtered";
readonly trace?: ConverseTrace;
readonly usage: TokenUsage;
} {
constructor(...args: [props: {
readonly additionalModelResponseFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly metrics: ConverseMetrics;
readonly output: ConverseOutput;
readonly performanceConfig?: {
readonly latency: "standard";
};
readonly stopReason: "content_filtered";
readonly trace?: ConverseTrace;
readonly usage: TokenUsage;
}, options?: MakeOptions]);
}

Signature

declare const ConverseResponseStreamEvent: any

Signature

declare class ConverseStreamMetadataEvent extends {
readonly metrics: ConverseStreamMetrics;
readonly performanceConfig?: PerformanceConfiguration;
readonly trace?: ConverseStreamTrace;
readonly usage: TokenUsage;
} {
constructor(...args: [props: {
readonly metrics: ConverseStreamMetrics;
readonly performanceConfig?: PerformanceConfiguration;
readonly trace?: ConverseStreamTrace;
readonly usage: TokenUsage;
}, options?: MakeOptions]);
}

Signature

declare class ConverseStreamMetrics extends {
readonly latencyMs: Duration;
} {
constructor(...args: [props: {
readonly latencyMs: Duration;
}, options?: MakeOptions]);
}

Signature

declare class ConverseStreamTrace extends {
readonly guardrail?: GuardrailTraceAssessment;
readonly promptRouter?: PromptRouterTrace;
} {
constructor(...args: [props?: {
readonly guardrail?: GuardrailTraceAssessment;
readonly promptRouter?: PromptRouterTrace;
}, options?: MakeOptions]);
}

Signature

declare class ConverseTrace extends {
readonly guardrail?: GuardrailTraceAssessment;
readonly promptRouter?: PromptRouterTrace;
} {
constructor(...args: [props?: {
readonly guardrail?: GuardrailTraceAssessment;
readonly promptRouter?: PromptRouterTrace;
}, options?: MakeOptions]);
}

Signature

declare class DocumentBlock extends {
readonly format: "csv";
readonly name: unknown;
readonly source: {
readonly bytes: string;
};
} {
constructor(...args: [props: {
readonly format: "csv";
readonly name: unknown;
readonly source: {
readonly bytes: string;
};
}, options?: MakeOptions]);
}

Signature

declare const DocumentFormat: Literal<"csv">

DocumentFormat type

Added in v1.0.0 Source

Signature

type DocumentFormat = typeof DocumentFormat.Type

Signature

declare class GuardrailAssessment extends {
readonly contentPolicy?: GuardrailContentPolicyAssessment;
readonly contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment;
readonly invocationMetrics?: GuardrailInvocationMetrics;
readonly sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
readonly topicPolicy?: GuardrailTopicPolicyAssessment;
readonly wordPolicy?: GuardrailWordPolicyAssessment;
} {
constructor(...args: [props?: {
readonly contentPolicy?: GuardrailContentPolicyAssessment;
readonly contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment;
readonly invocationMetrics?: GuardrailInvocationMetrics;
readonly sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
readonly topicPolicy?: GuardrailTopicPolicyAssessment;
readonly wordPolicy?: GuardrailWordPolicyAssessment;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailConfiguration extends {
readonly guardrailIdentifier: unknown;
readonly guardrailVersion: unknown;
readonly trace?: "enabled";
} {
constructor(...args: [props: {
readonly guardrailIdentifier: unknown;
readonly guardrailVersion: unknown;
readonly trace?: "enabled";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailContentFilter extends {
readonly action: "BLOCKED";
readonly confidence: "NONE";
readonly detected?: boolean;
readonly filterStrength?: "NONE";
readonly type: "HATE";
} {
constructor(...args: [props: {
readonly action: "BLOCKED";
readonly confidence: "NONE";
readonly detected?: boolean;
readonly filterStrength?: "NONE";
readonly type: "HATE";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailContentPolicyAssessment extends {
readonly filters: readonly Array<GuardrailContentFilter>;
} {
constructor(...args: [props: {
readonly filters: readonly Array<GuardrailContentFilter>;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailContextualGroundingFilter extends {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly score: unknown;
readonly threshold: unknown;
readonly type: "GROUNDING";
} {
constructor(...args: [props: {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly score: unknown;
readonly threshold: unknown;
readonly type: "GROUNDING";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailContextualGroundingPolicyAssessment extends {
readonly filters?: readonly Array<GuardrailContextualGroundingFilter>;
} {
constructor(...args: [props?: {
readonly filters?: readonly Array<GuardrailContextualGroundingFilter>;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailConverseContentBlock extends {} {
constructor(_: never);
}

Signature

declare class GuardrailConverseImageBlock extends {
readonly format: "png";
readonly source: {
readonly bytes: string;
};
} {
constructor(...args: [props: {
readonly format: "png";
readonly source: {
readonly bytes: string;
};
}, options?: MakeOptions]);
}

Signature

declare class GuardrailConverseTextBlock extends {
readonly qualifiers?: readonly Array<"guard_content">;
readonly text: string;
} {
constructor(...args: [props: {
readonly qualifiers?: readonly Array<"guard_content">;
readonly text: string;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailCoverage extends {
readonly images?: GuardrailImageCoverage;
readonly textCharacters?: GuardrailTextCharactersCoverage;
} {
constructor(...args: [props?: {
readonly images?: GuardrailImageCoverage;
readonly textCharacters?: GuardrailTextCharactersCoverage;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailCustomWord extends {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly match: string;
} {
constructor(...args: [props: {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly match: string;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailImageCoverage extends {
readonly guarded?: number;
readonly total?: number;
} {
constructor(...args: [props?: {
readonly guarded?: number;
readonly total?: number;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailInvocationMetrics extends {
readonly guardrailCoverage?: GuardrailCoverage;
readonly guardrailProcessingLatency?: number;
readonly usage?: GuardrailUsage;
} {
constructor(...args: [props?: {
readonly guardrailCoverage?: GuardrailCoverage;
readonly guardrailProcessingLatency?: number;
readonly usage?: GuardrailUsage;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailManagedWord extends {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly match: string;
readonly type: "PROFANITY";
} {
constructor(...args: [props: {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly match: string;
readonly type: "PROFANITY";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailPiiEntityFilter extends {
readonly action: "ANONYMIZED";
readonly detected?: boolean;
readonly match: string;
readonly type: "ADDRESS";
} {
constructor(...args: [props: {
readonly action: "ANONYMIZED";
readonly detected?: boolean;
readonly match: string;
readonly type: "ADDRESS";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailRegexFilter extends {
readonly action: "ANONYMIZED";
readonly detected?: boolean;
readonly match?: string;
readonly name?: string;
readonly regex?: string;
} {
constructor(...args: [props: {
readonly action: "ANONYMIZED";
readonly detected?: boolean;
readonly match?: string;
readonly name?: string;
readonly regex?: string;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailSensitiveInformationPolicyAssessment extends {
readonly piiEntities: readonly Array<GuardrailPiiEntityFilter>;
readonly regexes: readonly Array<GuardrailRegexFilter>;
} {
constructor(...args: [props: {
readonly piiEntities: readonly Array<GuardrailPiiEntityFilter>;
readonly regexes: readonly Array<GuardrailRegexFilter>;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailTextCharactersCoverage extends {
readonly guarded?: number;
readonly total?: number;
} {
constructor(...args: [props?: {
readonly guarded?: number;
readonly total?: number;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailTopic extends {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly name: string;
readonly type: "DENY";
} {
constructor(...args: [props: {
readonly action: "BLOCKED";
readonly detected?: boolean;
readonly name: string;
readonly type: "DENY";
}, options?: MakeOptions]);
}

Signature

declare class GuardrailTopicPolicyAssessment extends {
readonly topics: readonly Array<GuardrailTopic>;
} {
constructor(...args: [props: {
readonly topics: readonly Array<GuardrailTopic>;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailTraceAssessment extends {
readonly actionReason?: string;
readonly inputAssessment?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly modelOutput?: readonly Array<string>;
readonly outputAssessments?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
} {
constructor(...args: [props?: {
readonly actionReason?: string;
readonly inputAssessment?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly modelOutput?: readonly Array<string>;
readonly outputAssessments?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
}, options?: MakeOptions]);
}

Signature

declare class GuardrailUsage extends {
readonly contentPolicyImageUnits?: number;
readonly contentPolicyUnits: number;
readonly contextualGroundingPolicyUnits: number;
readonly sensitiveInformationPolicyFreeUnits: number;
readonly sensitiveInformationPolicyUnits: number;
readonly topicPolicyUnits: number;
readonly wordPolicyUnits: number;
} {
constructor(...args: [props: {
readonly contentPolicyImageUnits?: number;
readonly contentPolicyUnits: number;
readonly contextualGroundingPolicyUnits: number;
readonly sensitiveInformationPolicyFreeUnits: number;
readonly sensitiveInformationPolicyUnits: number;
readonly topicPolicyUnits: number;
readonly wordPolicyUnits: number;
}, options?: MakeOptions]);
}

Signature

declare class GuardrailWordPolicyAssessment extends {
readonly customWords: GuardrailCustomWord;
readonly managedWordLists: GuardrailManagedWord;
} {
constructor(...args: [props: {
readonly customWords: GuardrailCustomWord;
readonly managedWordLists: GuardrailManagedWord;
}, options?: MakeOptions]);
}

ImageBlock

Added in v1.0.0 Source

Signature

declare class ImageBlock extends {
readonly format: "gif";
readonly source: {
readonly bytes: string;
};
} {
constructor(...args: [props: {
readonly format: "gif";
readonly source: {
readonly bytes: string;
};
}, options?: MakeOptions]);
}

ImageFormat

Added in v1.0.0 Source

Signature

declare const ImageFormat: Literal<"gif">

ImageFormat type

Added in v1.0.0 Source

Signature

type ImageFormat = typeof ImageFormat.Type

Signature

declare class InferenceConfiguration extends {
readonly maxTokens?: undefined;
readonly stopSequences?: undefined;
readonly temperature?: undefined;
readonly topP?: undefined;
} {
constructor(...args: [props?: {
readonly maxTokens?: undefined;
readonly stopSequences?: undefined;
readonly temperature?: undefined;
readonly topP?: undefined;
}, options?: MakeOptions]);
}

Signature

declare const IntZeroOrGreater: never

JsonBlock

Added in v1.0.0 Source

Signature

declare class JsonBlock extends {
readonly json: unknown;
} {
constructor(...args: [props: {
readonly json: unknown;
}, options?: MakeOptions]);
}

Message

Added in v1.0.0 Source

Signature

declare class Message extends {
readonly content: readonly Array<never>;
readonly role: "user";
} {
constructor(...args: [props: {
readonly content: readonly Array<never>;
readonly role: "user";
}, options?: MakeOptions]);
}

Signature

declare class MessageStartEvent extends {
readonly role: "user";
} {
constructor(...args: [props: {
readonly role: "user";
}, options?: MakeOptions]);
}

Signature

declare class MessageStopEvent extends {
readonly additionalModelResponseFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly stopReason: "end_turn";
} {
constructor(...args: [props: {
readonly additionalModelResponseFields?: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
readonly stopReason: "end_turn";
}, options?: MakeOptions]);
}

Signature

declare class PerformanceConfiguration extends {
readonly latency?: "standard";
} {
constructor(...args: [props?: {
readonly latency?: "standard";
}, options?: MakeOptions]);
}

Signature

declare class PromptRouterTrace extends {
readonly invokedModelId?: undefined;
} {
constructor(...args: [props?: {
readonly invokedModelId?: undefined;
}, options?: MakeOptions]);
}

Signature

declare class ReasoningContentBlock extends {} {
constructor(_: never);
}

Signature

declare class ReasoningContentBlockDelta extends {} {
constructor(_: never);
}

StopReason

Added in v1.0.0 Source

Signature

declare const StopReason: Literal<"end_turn">

StopReason type

Added in v1.0.0 Source

Signature

type StopReason = typeof StopReason.Type

Signature

declare class SystemContentBlock extends {} {
constructor(_: never);
}

TokenUsage

Added in v1.0.0 Source

Signature

declare class TokenUsage extends {
readonly cacheReadInputTokens?: undefined;
readonly cacheWriteInputTokens?: undefined;
inputTokens?: undefined;
outputTokens?: undefined;
totalTokens?: undefined;
} {
constructor(...args: [props?: {
readonly cacheReadInputTokens?: undefined;
readonly cacheWriteInputTokens?: undefined;
readonly inputTokens?: undefined;
readonly outputTokens?: undefined;
readonly totalTokens?: undefined;
}, options?: MakeOptions]);
}

Tool

Added in v1.0.0 Source

Signature

declare class Tool extends {
readonly cachePoint?: CachePointBlock;
readonly toolSpec?: ToolSpecification;
} {
constructor(...args: [props?: {
readonly cachePoint?: CachePointBlock;
readonly toolSpec?: ToolSpecification;
}, options?: MakeOptions]);
}

ToolChoice

Added in v1.0.0 Source

Signature

declare class ToolChoice extends {} {
constructor(_: never);
}

Signature

declare class ToolConfiguration extends {
readonly toolChoice?: unknown;
readonly tools: unknown;
} {
constructor(...args: [props: {
readonly toolChoice?: unknown;
readonly tools: unknown;
}, options?: MakeOptions]);
}

Signature

declare class ToolResultBlock extends {
readonly content: readonly Array<unknown>;
readonly status?: "success";
readonly toolUseId: unknown;
} {
constructor(...args: [props: {
readonly content: readonly Array<unknown>;
readonly status?: "success";
readonly toolUseId: unknown;
}, options?: MakeOptions]);
}

Signature

declare class ToolSpecification extends {
readonly description?: undefined;
readonly inputSchema: {
readonly json: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
};
readonly name: unknown;
} {
constructor(...args: [props: {
readonly description?: undefined;
readonly inputSchema: {
readonly json: {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
};
};
readonly name: unknown;
}, options?: MakeOptions]);
}

ToolUseBlock

Added in v1.0.0 Source

Signature

declare class ToolUseBlock extends {
readonly input: unknown;
readonly name: unknown;
readonly toolUseId: unknown;
} {
constructor(...args: [props: {
readonly input: unknown;
readonly name: unknown;
readonly toolUseId: unknown;
}, options?: MakeOptions]);
}

Signature

declare class ToolUseBlockDelta extends {
readonly input: string;
} {
constructor(...args: [props: {
readonly input: string;
}, options?: MakeOptions]);
}

Signature

declare class ToolUseBlockStart extends {
readonly name: unknown;
readonly toolUseId: unknown;
} {
constructor(...args: [props: {
readonly name: unknown;
readonly toolUseId: unknown;
}, options?: MakeOptions]);
}

VideoBlock

Added in v1.0.0 Source

Signature

declare class VideoBlock extends {
readonly format: "flv";
readonly source: unknown;
} {
constructor(...args: [props: {
readonly format: "flv";
readonly source: unknown;
}, options?: MakeOptions]);
}