Type definitions#
Index > AgentsforBedrockRuntime > Type definitions
Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime.datetime,
str,
]InferenceConfigurationUnionTypeDef#
# InferenceConfigurationUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InferenceConfigurationUnionTypeDef
def get_value() -> InferenceConfigurationUnionTypeDef:
return ...
# InferenceConfigurationUnionTypeDef definition
InferenceConfigurationUnionTypeDef = Union[
InferenceConfigurationTypeDef, # (1)
InferenceConfigurationOutputTypeDef, # (2)
]ImageInputSourceUnionTypeDef#
# ImageInputSourceUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputSourceUnionTypeDef
def get_value() -> ImageInputSourceUnionTypeDef:
return ...
# ImageInputSourceUnionTypeDef definition
ImageInputSourceUnionTypeDef = Union[
ImageInputSourceTypeDef, # (1)
ImageInputSourceOutputTypeDef, # (2)
]RerankDocumentUnionTypeDef#
# RerankDocumentUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankDocumentUnionTypeDef
def get_value() -> RerankDocumentUnionTypeDef:
return ...
# RerankDocumentUnionTypeDef definition
RerankDocumentUnionTypeDef = Union[
RerankDocumentTypeDef, # (1)
RerankDocumentOutputTypeDef, # (2)
]ImageInputUnionTypeDef#
# ImageInputUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputUnionTypeDef
def get_value() -> ImageInputUnionTypeDef:
return ...
# ImageInputUnionTypeDef definition
ImageInputUnionTypeDef = Union[
ImageInputTypeDef, # (1)
ImageInputOutputTypeDef, # (2)
]InvocationStepPayloadUnionTypeDef#
# InvocationStepPayloadUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationStepPayloadUnionTypeDef
def get_value() -> InvocationStepPayloadUnionTypeDef:
return ...
# InvocationStepPayloadUnionTypeDef definition
InvocationStepPayloadUnionTypeDef = Union[
InvocationStepPayloadTypeDef, # (1)
InvocationStepPayloadOutputTypeDef, # (2)
]ContentBodyUnionTypeDef#
# ContentBodyUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ContentBodyUnionTypeDef
def get_value() -> ContentBodyUnionTypeDef:
return ...
# ContentBodyUnionTypeDef definition
ContentBodyUnionTypeDef = Union[
ContentBodyTypeDef, # (1)
ContentBodyOutputTypeDef, # (2)
]ApiResultUnionTypeDef#
# ApiResultUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiResultUnionTypeDef
def get_value() -> ApiResultUnionTypeDef:
return ...
# ApiResultUnionTypeDef definition
ApiResultUnionTypeDef = Union[
ApiResultTypeDef, # (1)
ApiResultOutputTypeDef, # (2)
]FunctionResultUnionTypeDef#
# FunctionResultUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionResultUnionTypeDef
def get_value() -> FunctionResultUnionTypeDef:
return ...
# FunctionResultUnionTypeDef definition
FunctionResultUnionTypeDef = Union[
FunctionResultTypeDef, # (1)
FunctionResultOutputTypeDef, # (2)
]InvocationResultMemberUnionTypeDef#
# InvocationResultMemberUnionTypeDef Union usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationResultMemberUnionTypeDef
def get_value() -> InvocationResultMemberUnionTypeDef:
return ...
# InvocationResultMemberUnionTypeDef definition
InvocationResultMemberUnionTypeDef = Union[
InvocationResultMemberTypeDef, # (1)
InvocationResultMemberOutputTypeDef, # (2)
]S3IdentifierTypeDef#
# S3IdentifierTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import S3IdentifierTypeDef
def get_value() -> S3IdentifierTypeDef:
return {
"s3BucketName": ...,
}
# S3IdentifierTypeDef definition
class S3IdentifierTypeDef(TypedDict):
s3BucketName: NotRequired[str],
s3ObjectKey: NotRequired[str],AccessDeniedExceptionTypeDef#
# AccessDeniedExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AccessDeniedExceptionTypeDef
def get_value() -> AccessDeniedExceptionTypeDef:
return {
"message": ...,
}
# AccessDeniedExceptionTypeDef definition
class AccessDeniedExceptionTypeDef(TypedDict):
message: NotRequired[str],ActionGroupExecutorTypeDef#
# ActionGroupExecutorTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ActionGroupExecutorTypeDef
def get_value() -> ActionGroupExecutorTypeDef:
return {
"customControl": ...,
}
# ActionGroupExecutorTypeDef definition
class ActionGroupExecutorTypeDef(TypedDict):
customControl: NotRequired[CustomControlMethodType], # (1)
lambda: NotRequired[str],ParameterTypeDef#
# ParameterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ParameterTypeDef
def get_value() -> ParameterTypeDef:
return {
"name": ...,
}
# ParameterTypeDef definition
class ParameterTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[str],
value: NotRequired[str],ActionGroupInvocationOutputTypeDef#
# ActionGroupInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ActionGroupInvocationOutputTypeDef
def get_value() -> ActionGroupInvocationOutputTypeDef:
return {
"text": ...,
}
# ActionGroupInvocationOutputTypeDef definition
class ActionGroupInvocationOutputTypeDef(TypedDict):
text: NotRequired[str],AnalyzePromptEventTypeDef#
# AnalyzePromptEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AnalyzePromptEventTypeDef
def get_value() -> AnalyzePromptEventTypeDef:
return {
"message": ...,
}
# AnalyzePromptEventTypeDef definition
class AnalyzePromptEventTypeDef(TypedDict):
message: NotRequired[str],ApiParameterTypeDef#
# ApiParameterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiParameterTypeDef
def get_value() -> ApiParameterTypeDef:
return {
"name": ...,
}
# ApiParameterTypeDef definition
class ApiParameterTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[str],
value: NotRequired[str],BadGatewayExceptionTypeDef#
# BadGatewayExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BadGatewayExceptionTypeDef
def get_value() -> BadGatewayExceptionTypeDef:
return {
"message": ...,
}
# BadGatewayExceptionTypeDef definition
class BadGatewayExceptionTypeDef(TypedDict):
message: NotRequired[str],
resourceName: NotRequired[str],PerformanceConfigurationTypeDef#
# PerformanceConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PerformanceConfigurationTypeDef
def get_value() -> PerformanceConfigurationTypeDef:
return {
"latency": ...,
}
# PerformanceConfigurationTypeDef definition
class PerformanceConfigurationTypeDef(TypedDict):
latency: NotRequired[PerformanceConfigLatencyType], # (1)BedrockRerankingModelConfigurationTypeDef#
# BedrockRerankingModelConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BedrockRerankingModelConfigurationTypeDef
def get_value() -> BedrockRerankingModelConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# BedrockRerankingModelConfigurationTypeDef definition
class BedrockRerankingModelConfigurationTypeDef(TypedDict):
modelArn: str,
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],CallerTypeDef#
# CallerTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CallerTypeDef
def get_value() -> CallerTypeDef:
return {
"agentAliasArn": ...,
}
# CallerTypeDef definition
class CallerTypeDef(TypedDict):
agentAliasArn: NotRequired[str],CodeInterpreterInvocationInputTypeDef#
# CodeInterpreterInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CodeInterpreterInvocationInputTypeDef
def get_value() -> CodeInterpreterInvocationInputTypeDef:
return {
"code": ...,
}
# CodeInterpreterInvocationInputTypeDef definition
class CodeInterpreterInvocationInputTypeDef(TypedDict):
code: NotRequired[str],
files: NotRequired[List[str]],CodeInterpreterInvocationOutputTypeDef#
# CodeInterpreterInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CodeInterpreterInvocationOutputTypeDef
def get_value() -> CodeInterpreterInvocationOutputTypeDef:
return {
"executionError": ...,
}
# CodeInterpreterInvocationOutputTypeDef definition
class CodeInterpreterInvocationOutputTypeDef(TypedDict):
executionError: NotRequired[str],
executionOutput: NotRequired[str],
executionTimeout: NotRequired[bool],
files: NotRequired[List[str]],CollaboratorConfigurationTypeDef#
# CollaboratorConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CollaboratorConfigurationTypeDef
def get_value() -> CollaboratorConfigurationTypeDef:
return {
"agentAliasArn": ...,
}
# CollaboratorConfigurationTypeDef definition
class CollaboratorConfigurationTypeDef(TypedDict):
collaboratorInstruction: str,
collaboratorName: str,
agentAliasArn: NotRequired[str],
relayConversationHistory: NotRequired[RelayConversationHistoryType], # (1)GuardrailConfigurationWithArnTypeDef#
# GuardrailConfigurationWithArnTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailConfigurationWithArnTypeDef
def get_value() -> GuardrailConfigurationWithArnTypeDef:
return {
"guardrailIdentifier": ...,
}
# GuardrailConfigurationWithArnTypeDef definition
class GuardrailConfigurationWithArnTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: str,ConflictExceptionTypeDef#
# ConflictExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ConflictExceptionTypeDef
def get_value() -> ConflictExceptionTypeDef:
return {
"message": ...,
}
# ConflictExceptionTypeDef definition
class ConflictExceptionTypeDef(TypedDict):
message: NotRequired[str],ContentBlockTypeDef#
# ContentBlockTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ContentBlockTypeDef
def get_value() -> ContentBlockTypeDef:
return {
"text": ...,
}
# ContentBlockTypeDef definition
class ContentBlockTypeDef(TypedDict):
text: NotRequired[str],CreateInvocationRequestTypeDef#
# CreateInvocationRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CreateInvocationRequestTypeDef
def get_value() -> CreateInvocationRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# CreateInvocationRequestTypeDef definition
class CreateInvocationRequestTypeDef(TypedDict):
sessionIdentifier: str,
description: NotRequired[str],
invocationId: NotRequired[str],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],CreateSessionRequestTypeDef#
# CreateSessionRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CreateSessionRequestTypeDef
def get_value() -> CreateSessionRequestTypeDef:
return {
"encryptionKeyArn": ...,
}
# CreateSessionRequestTypeDef definition
class CreateSessionRequestTypeDef(TypedDict):
encryptionKeyArn: NotRequired[str],
sessionMetadata: NotRequired[Mapping[str, str]],
tags: NotRequired[Mapping[str, str]],CustomOrchestrationTraceEventTypeDef#
# CustomOrchestrationTraceEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CustomOrchestrationTraceEventTypeDef
def get_value() -> CustomOrchestrationTraceEventTypeDef:
return {
"text": ...,
}
# CustomOrchestrationTraceEventTypeDef definition
class CustomOrchestrationTraceEventTypeDef(TypedDict):
text: NotRequired[str],DeleteAgentMemoryRequestTypeDef#
# DeleteAgentMemoryRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import DeleteAgentMemoryRequestTypeDef
def get_value() -> DeleteAgentMemoryRequestTypeDef:
return {
"agentAliasId": ...,
}
# DeleteAgentMemoryRequestTypeDef definition
class DeleteAgentMemoryRequestTypeDef(TypedDict):
agentAliasId: str,
agentId: str,
memoryId: NotRequired[str],
sessionId: NotRequired[str],DeleteSessionRequestTypeDef#
# DeleteSessionRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import DeleteSessionRequestTypeDef
def get_value() -> DeleteSessionRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# DeleteSessionRequestTypeDef definition
class DeleteSessionRequestTypeDef(TypedDict):
sessionIdentifier: str,DependencyFailedExceptionTypeDef#
# DependencyFailedExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import DependencyFailedExceptionTypeDef
def get_value() -> DependencyFailedExceptionTypeDef:
return {
"message": ...,
}
# DependencyFailedExceptionTypeDef definition
class DependencyFailedExceptionTypeDef(TypedDict):
message: NotRequired[str],
resourceName: NotRequired[str],EndSessionRequestTypeDef#
# EndSessionRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import EndSessionRequestTypeDef
def get_value() -> EndSessionRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# EndSessionRequestTypeDef definition
class EndSessionRequestTypeDef(TypedDict):
sessionIdentifier: str,S3ObjectDocTypeDef#
# S3ObjectDocTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import S3ObjectDocTypeDef
def get_value() -> S3ObjectDocTypeDef:
return {
"uri": ...,
}
# S3ObjectDocTypeDef definition
class S3ObjectDocTypeDef(TypedDict):
uri: str,GuardrailConfigurationTypeDef#
# GuardrailConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailConfigurationTypeDef
def get_value() -> GuardrailConfigurationTypeDef:
return {
"guardrailId": ...,
}
# GuardrailConfigurationTypeDef definition
class GuardrailConfigurationTypeDef(TypedDict):
guardrailId: str,
guardrailVersion: str,PromptTemplateTypeDef#
# PromptTemplateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PromptTemplateTypeDef
def get_value() -> PromptTemplateTypeDef:
return {
"textPromptTemplate": ...,
}
# PromptTemplateTypeDef definition
class PromptTemplateTypeDef(TypedDict):
textPromptTemplate: NotRequired[str],FailureTraceTypeDef#
# FailureTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FailureTraceTypeDef
def get_value() -> FailureTraceTypeDef:
return {
"failureReason": ...,
}
# FailureTraceTypeDef definition
class FailureTraceTypeDef(TypedDict):
failureReason: NotRequired[str],
traceId: NotRequired[str],FieldForRerankingTypeDef#
# FieldForRerankingTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FieldForRerankingTypeDef
def get_value() -> FieldForRerankingTypeDef:
return {
"fieldName": ...,
}
# FieldForRerankingTypeDef definition
class FieldForRerankingTypeDef(TypedDict):
fieldName: str,OutputFileTypeDef#
# OutputFileTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OutputFileTypeDef
def get_value() -> OutputFileTypeDef:
return {
"bytes": ...,
}
# OutputFileTypeDef definition
class OutputFileTypeDef(TypedDict):
bytes: NotRequired[bytes],
name: NotRequired[str],
type: NotRequired[str],S3ObjectFileTypeDef#
# S3ObjectFileTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import S3ObjectFileTypeDef
def get_value() -> S3ObjectFileTypeDef:
return {
"uri": ...,
}
# S3ObjectFileTypeDef definition
class S3ObjectFileTypeDef(TypedDict):
uri: str,FilterAttributeTypeDef#
# FilterAttributeTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FilterAttributeTypeDef
def get_value() -> FilterAttributeTypeDef:
return {
"key": ...,
}
# FilterAttributeTypeDef definition
class FilterAttributeTypeDef(TypedDict):
key: str,
value: Mapping[str, Any],FinalResponseTypeDef#
# FinalResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FinalResponseTypeDef
def get_value() -> FinalResponseTypeDef:
return {
"text": ...,
}
# FinalResponseTypeDef definition
class FinalResponseTypeDef(TypedDict):
text: NotRequired[str],FlowCompletionEventTypeDef#
# FlowCompletionEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowCompletionEventTypeDef
def get_value() -> FlowCompletionEventTypeDef:
return {
"completionReason": ...,
}
# FlowCompletionEventTypeDef definition
class FlowCompletionEventTypeDef(TypedDict):
completionReason: FlowCompletionReasonType, # (1)FlowInputContentTypeDef#
# FlowInputContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowInputContentTypeDef
def get_value() -> FlowInputContentTypeDef:
return {
"document": ...,
}
# FlowInputContentTypeDef definition
class FlowInputContentTypeDef(TypedDict):
document: NotRequired[Mapping[str, Any]],FlowMultiTurnInputContentTypeDef#
# FlowMultiTurnInputContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowMultiTurnInputContentTypeDef
def get_value() -> FlowMultiTurnInputContentTypeDef:
return {
"document": ...,
}
# FlowMultiTurnInputContentTypeDef definition
class FlowMultiTurnInputContentTypeDef(TypedDict):
document: NotRequired[Dict[str, Any]],FlowOutputContentTypeDef#
# FlowOutputContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowOutputContentTypeDef
def get_value() -> FlowOutputContentTypeDef:
return {
"document": ...,
}
# FlowOutputContentTypeDef definition
class FlowOutputContentTypeDef(TypedDict):
document: NotRequired[Dict[str, Any]],InternalServerExceptionTypeDef#
# InternalServerExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InternalServerExceptionTypeDef
def get_value() -> InternalServerExceptionTypeDef:
return {
"message": ...,
}
# InternalServerExceptionTypeDef definition
class InternalServerExceptionTypeDef(TypedDict):
message: NotRequired[str],
reason: NotRequired[str],ResourceNotFoundExceptionTypeDef#
# ResourceNotFoundExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ResourceNotFoundExceptionTypeDef
def get_value() -> ResourceNotFoundExceptionTypeDef:
return {
"message": ...,
}
# ResourceNotFoundExceptionTypeDef definition
class ResourceNotFoundExceptionTypeDef(TypedDict):
message: NotRequired[str],ServiceQuotaExceededExceptionTypeDef#
# ServiceQuotaExceededExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ServiceQuotaExceededExceptionTypeDef
def get_value() -> ServiceQuotaExceededExceptionTypeDef:
return {
"message": ...,
}
# ServiceQuotaExceededExceptionTypeDef definition
class ServiceQuotaExceededExceptionTypeDef(TypedDict):
message: NotRequired[str],ThrottlingExceptionTypeDef#
# ThrottlingExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ThrottlingExceptionTypeDef
def get_value() -> ThrottlingExceptionTypeDef:
return {
"message": ...,
}
# ThrottlingExceptionTypeDef definition
class ThrottlingExceptionTypeDef(TypedDict):
message: NotRequired[str],ValidationExceptionTypeDef#
# ValidationExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ValidationExceptionTypeDef
def get_value() -> ValidationExceptionTypeDef:
return {
"message": ...,
}
# ValidationExceptionTypeDef definition
class ValidationExceptionTypeDef(TypedDict):
message: NotRequired[str],FlowTraceConditionTypeDef#
# FlowTraceConditionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceConditionTypeDef
def get_value() -> FlowTraceConditionTypeDef:
return {
"conditionName": ...,
}
# FlowTraceConditionTypeDef definition
class FlowTraceConditionTypeDef(TypedDict):
conditionName: str,FlowTraceNodeActionEventTypeDef#
# FlowTraceNodeActionEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeActionEventTypeDef
def get_value() -> FlowTraceNodeActionEventTypeDef:
return {
"nodeName": ...,
}
# FlowTraceNodeActionEventTypeDef definition
class FlowTraceNodeActionEventTypeDef(TypedDict):
nodeName: str,
operationName: str,
requestId: str,
serviceName: str,
timestamp: datetime.datetime,FlowTraceNodeInputContentTypeDef#
# FlowTraceNodeInputContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeInputContentTypeDef
def get_value() -> FlowTraceNodeInputContentTypeDef:
return {
"document": ...,
}
# FlowTraceNodeInputContentTypeDef definition
class FlowTraceNodeInputContentTypeDef(TypedDict):
document: NotRequired[Dict[str, Any]],FlowTraceNodeOutputContentTypeDef#
# FlowTraceNodeOutputContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeOutputContentTypeDef
def get_value() -> FlowTraceNodeOutputContentTypeDef:
return {
"document": ...,
}
# FlowTraceNodeOutputContentTypeDef definition
class FlowTraceNodeOutputContentTypeDef(TypedDict):
document: NotRequired[Dict[str, Any]],ParameterDetailTypeDef#
# ParameterDetailTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ParameterDetailTypeDef
def get_value() -> ParameterDetailTypeDef:
return {
"description": ...,
}
# ParameterDetailTypeDef definition
class ParameterDetailTypeDef(TypedDict):
type: ParameterTypeType, # (1)
description: NotRequired[str],
required: NotRequired[bool],FunctionParameterTypeDef#
# FunctionParameterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionParameterTypeDef
def get_value() -> FunctionParameterTypeDef:
return {
"name": ...,
}
# FunctionParameterTypeDef definition
class FunctionParameterTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[str],
value: NotRequired[str],QueryGenerationInputTypeDef#
# QueryGenerationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import QueryGenerationInputTypeDef
def get_value() -> QueryGenerationInputTypeDef:
return {
"text": ...,
}
# QueryGenerationInputTypeDef definition
class QueryGenerationInputTypeDef(TypedDict):
text: str,
type: InputQueryTypeType, # (1)GeneratedQueryTypeDef#
# GeneratedQueryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GeneratedQueryTypeDef
def get_value() -> GeneratedQueryTypeDef:
return {
"sql": ...,
}
# GeneratedQueryTypeDef definition
class GeneratedQueryTypeDef(TypedDict):
sql: NotRequired[str],
type: NotRequired[GeneratedQueryTypeType], # (1)PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],GetAgentMemoryRequestTypeDef#
# GetAgentMemoryRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetAgentMemoryRequestTypeDef
def get_value() -> GetAgentMemoryRequestTypeDef:
return {
"agentAliasId": ...,
}
# GetAgentMemoryRequestTypeDef definition
class GetAgentMemoryRequestTypeDef(TypedDict):
agentAliasId: str,
agentId: str,
memoryId: str,
memoryType: MemoryTypeType, # (1)
maxItems: NotRequired[int],
nextToken: NotRequired[str],- See MemoryTypeType
GetInvocationStepRequestTypeDef#
# GetInvocationStepRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetInvocationStepRequestTypeDef
def get_value() -> GetInvocationStepRequestTypeDef:
return {
"invocationIdentifier": ...,
}
# GetInvocationStepRequestTypeDef definition
class GetInvocationStepRequestTypeDef(TypedDict):
invocationIdentifier: str,
invocationStepId: str,
sessionIdentifier: str,GetSessionRequestTypeDef#
# GetSessionRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetSessionRequestTypeDef
def get_value() -> GetSessionRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# GetSessionRequestTypeDef definition
class GetSessionRequestTypeDef(TypedDict):
sessionIdentifier: str,GuardrailContentFilterTypeDef#
# GuardrailContentFilterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailContentFilterTypeDef
def get_value() -> GuardrailContentFilterTypeDef:
return {
"action": ...,
}
# GuardrailContentFilterTypeDef definition
class GuardrailContentFilterTypeDef(TypedDict):
action: NotRequired[GuardrailContentPolicyActionType], # (1)
confidence: NotRequired[GuardrailContentFilterConfidenceType], # (2)
type: NotRequired[GuardrailContentFilterTypeType], # (3)- See GuardrailContentPolicyActionType
- See GuardrailContentFilterConfidenceType
- See GuardrailContentFilterTypeType
GuardrailCustomWordTypeDef#
# GuardrailCustomWordTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailCustomWordTypeDef
def get_value() -> GuardrailCustomWordTypeDef:
return {
"action": ...,
}
# GuardrailCustomWordTypeDef definition
class GuardrailCustomWordTypeDef(TypedDict):
action: NotRequired[GuardrailWordPolicyActionType], # (1)
match: NotRequired[str],GuardrailEventTypeDef#
# GuardrailEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailEventTypeDef
def get_value() -> GuardrailEventTypeDef:
return {
"action": ...,
}
# GuardrailEventTypeDef definition
class GuardrailEventTypeDef(TypedDict):
action: NotRequired[GuadrailActionType], # (1)GuardrailManagedWordTypeDef#
# GuardrailManagedWordTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailManagedWordTypeDef
def get_value() -> GuardrailManagedWordTypeDef:
return {
"action": ...,
}
# GuardrailManagedWordTypeDef definition
class GuardrailManagedWordTypeDef(TypedDict):
action: NotRequired[GuardrailWordPolicyActionType], # (1)
match: NotRequired[str],
type: NotRequired[GuardrailManagedWordTypeType], # (2)GuardrailPiiEntityFilterTypeDef#
# GuardrailPiiEntityFilterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailPiiEntityFilterTypeDef
def get_value() -> GuardrailPiiEntityFilterTypeDef:
return {
"action": ...,
}
# GuardrailPiiEntityFilterTypeDef definition
class GuardrailPiiEntityFilterTypeDef(TypedDict):
action: NotRequired[GuardrailSensitiveInformationPolicyActionType], # (1)
match: NotRequired[str],
type: NotRequired[GuardrailPiiEntityTypeType], # (2)GuardrailRegexFilterTypeDef#
# GuardrailRegexFilterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailRegexFilterTypeDef
def get_value() -> GuardrailRegexFilterTypeDef:
return {
"action": ...,
}
# GuardrailRegexFilterTypeDef definition
class GuardrailRegexFilterTypeDef(TypedDict):
action: NotRequired[GuardrailSensitiveInformationPolicyActionType], # (1)
match: NotRequired[str],
name: NotRequired[str],
regex: NotRequired[str],GuardrailTopicTypeDef#
# GuardrailTopicTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailTopicTypeDef
def get_value() -> GuardrailTopicTypeDef:
return {
"action": ...,
}
# GuardrailTopicTypeDef definition
class GuardrailTopicTypeDef(TypedDict):
action: NotRequired[GuardrailTopicPolicyActionType], # (1)
name: NotRequired[str],
type: NotRequired[GuardrailTopicTypeType], # (2)ImageInputSourceOutputTypeDef#
# ImageInputSourceOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputSourceOutputTypeDef
def get_value() -> ImageInputSourceOutputTypeDef:
return {
"bytes": ...,
}
# ImageInputSourceOutputTypeDef definition
class ImageInputSourceOutputTypeDef(TypedDict):
bytes: NotRequired[bytes],S3LocationTypeDef#
# S3LocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"uri": ...,
}
# S3LocationTypeDef definition
class S3LocationTypeDef(TypedDict):
uri: str,MetadataAttributeSchemaTypeDef#
# MetadataAttributeSchemaTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MetadataAttributeSchemaTypeDef
def get_value() -> MetadataAttributeSchemaTypeDef:
return {
"description": ...,
}
# MetadataAttributeSchemaTypeDef definition
class MetadataAttributeSchemaTypeDef(TypedDict):
description: str,
key: str,
type: AttributeTypeType, # (1)TextInferenceConfigTypeDef#
# TextInferenceConfigTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TextInferenceConfigTypeDef
def get_value() -> TextInferenceConfigTypeDef:
return {
"maxTokens": ...,
}
# TextInferenceConfigTypeDef definition
class TextInferenceConfigTypeDef(TypedDict):
maxTokens: NotRequired[int],
stopSequences: NotRequired[Sequence[str]],
temperature: NotRequired[float],
topP: NotRequired[float],InferenceConfigurationOutputTypeDef#
# InferenceConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InferenceConfigurationOutputTypeDef
def get_value() -> InferenceConfigurationOutputTypeDef:
return {
"maximumLength": ...,
}
# InferenceConfigurationOutputTypeDef definition
class InferenceConfigurationOutputTypeDef(TypedDict):
maximumLength: NotRequired[int],
stopSequences: NotRequired[List[str]],
temperature: NotRequired[float],
topK: NotRequired[int],
topP: NotRequired[float],InferenceConfigurationTypeDef#
# InferenceConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InferenceConfigurationTypeDef
def get_value() -> InferenceConfigurationTypeDef:
return {
"maximumLength": ...,
}
# InferenceConfigurationTypeDef definition
class InferenceConfigurationTypeDef(TypedDict):
maximumLength: NotRequired[int],
stopSequences: NotRequired[Sequence[str]],
temperature: NotRequired[float],
topK: NotRequired[int],
topP: NotRequired[float],TextPromptTypeDef#
# TextPromptTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TextPromptTypeDef
def get_value() -> TextPromptTypeDef:
return {
"text": ...,
}
# TextPromptTypeDef definition
class TextPromptTypeDef(TypedDict):
text: str,KnowledgeBaseLookupInputTypeDef#
# KnowledgeBaseLookupInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseLookupInputTypeDef
def get_value() -> KnowledgeBaseLookupInputTypeDef:
return {
"knowledgeBaseId": ...,
}
# KnowledgeBaseLookupInputTypeDef definition
class KnowledgeBaseLookupInputTypeDef(TypedDict):
knowledgeBaseId: NotRequired[str],
text: NotRequired[str],InvocationStepSummaryTypeDef#
# InvocationStepSummaryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationStepSummaryTypeDef
def get_value() -> InvocationStepSummaryTypeDef:
return {
"invocationId": ...,
}
# InvocationStepSummaryTypeDef definition
class InvocationStepSummaryTypeDef(TypedDict):
invocationId: str,
invocationStepId: str,
invocationStepTime: datetime.datetime,
sessionId: str,InvocationSummaryTypeDef#
# InvocationSummaryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationSummaryTypeDef
def get_value() -> InvocationSummaryTypeDef:
return {
"createdAt": ...,
}
# InvocationSummaryTypeDef definition
class InvocationSummaryTypeDef(TypedDict):
createdAt: datetime.datetime,
invocationId: str,
sessionId: str,StreamingConfigurationsTypeDef#
# StreamingConfigurationsTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import StreamingConfigurationsTypeDef
def get_value() -> StreamingConfigurationsTypeDef:
return {
"applyGuardrailInterval": ...,
}
# StreamingConfigurationsTypeDef definition
class StreamingConfigurationsTypeDef(TypedDict):
applyGuardrailInterval: NotRequired[int],
streamFinalResponse: NotRequired[bool],KnowledgeBaseQueryTypeDef#
# KnowledgeBaseQueryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseQueryTypeDef
def get_value() -> KnowledgeBaseQueryTypeDef:
return {
"text": ...,
}
# KnowledgeBaseQueryTypeDef definition
class KnowledgeBaseQueryTypeDef(TypedDict):
text: str,ListInvocationStepsRequestTypeDef#
# ListInvocationStepsRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationStepsRequestTypeDef
def get_value() -> ListInvocationStepsRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# ListInvocationStepsRequestTypeDef definition
class ListInvocationStepsRequestTypeDef(TypedDict):
sessionIdentifier: str,
invocationIdentifier: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListInvocationsRequestTypeDef#
# ListInvocationsRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationsRequestTypeDef
def get_value() -> ListInvocationsRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# ListInvocationsRequestTypeDef definition
class ListInvocationsRequestTypeDef(TypedDict):
sessionIdentifier: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListSessionsRequestTypeDef#
# ListSessionsRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListSessionsRequestTypeDef
def get_value() -> ListSessionsRequestTypeDef:
return {
"maxResults": ...,
}
# ListSessionsRequestTypeDef definition
class ListSessionsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],SessionSummaryTypeDef#
# SessionSummaryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import SessionSummaryTypeDef
def get_value() -> SessionSummaryTypeDef:
return {
"createdAt": ...,
}
# SessionSummaryTypeDef definition
class SessionSummaryTypeDef(TypedDict):
createdAt: datetime.datetime,
lastUpdatedAt: datetime.datetime,
sessionArn: str,
sessionId: str,
sessionStatus: SessionStatusType, # (1)ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,MemorySessionSummaryTypeDef#
# MemorySessionSummaryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MemorySessionSummaryTypeDef
def get_value() -> MemorySessionSummaryTypeDef:
return {
"memoryId": ...,
}
# MemorySessionSummaryTypeDef definition
class MemorySessionSummaryTypeDef(TypedDict):
memoryId: NotRequired[str],
sessionExpiryTime: NotRequired[datetime.datetime],
sessionId: NotRequired[str],
sessionStartTime: NotRequired[datetime.datetime],
summaryText: NotRequired[str],UsageTypeDef#
# UsageTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import UsageTypeDef
def get_value() -> UsageTypeDef:
return {
"inputTokens": ...,
}
# UsageTypeDef definition
class UsageTypeDef(TypedDict):
inputTokens: NotRequired[int],
outputTokens: NotRequired[int],ModelNotReadyExceptionTypeDef#
# ModelNotReadyExceptionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ModelNotReadyExceptionTypeDef
def get_value() -> ModelNotReadyExceptionTypeDef:
return {
"message": ...,
}
# ModelNotReadyExceptionTypeDef definition
class ModelNotReadyExceptionTypeDef(TypedDict):
message: NotRequired[str],RepromptResponseTypeDef#
# RepromptResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RepromptResponseTypeDef
def get_value() -> RepromptResponseTypeDef:
return {
"source": ...,
}
# RepromptResponseTypeDef definition
class RepromptResponseTypeDef(TypedDict):
source: NotRequired[SourceType], # (1)
text: NotRequired[str],- See SourceType
QueryTransformationConfigurationTypeDef#
# QueryTransformationConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import QueryTransformationConfigurationTypeDef
def get_value() -> QueryTransformationConfigurationTypeDef:
return {
"type": ...,
}
# QueryTransformationConfigurationTypeDef definition
class QueryTransformationConfigurationTypeDef(TypedDict):
type: QueryTransformationTypeType, # (1)RawResponseTypeDef#
# RawResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RawResponseTypeDef
def get_value() -> RawResponseTypeDef:
return {
"content": ...,
}
# RawResponseTypeDef definition
class RawResponseTypeDef(TypedDict):
content: NotRequired[str],RationaleTypeDef#
# RationaleTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RationaleTypeDef
def get_value() -> RationaleTypeDef:
return {
"text": ...,
}
# RationaleTypeDef definition
class RationaleTypeDef(TypedDict):
text: NotRequired[str],
traceId: NotRequired[str],PostProcessingParsedResponseTypeDef#
# PostProcessingParsedResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PostProcessingParsedResponseTypeDef
def get_value() -> PostProcessingParsedResponseTypeDef:
return {
"text": ...,
}
# PostProcessingParsedResponseTypeDef definition
class PostProcessingParsedResponseTypeDef(TypedDict):
text: NotRequired[str],PreProcessingParsedResponseTypeDef#
# PreProcessingParsedResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PreProcessingParsedResponseTypeDef
def get_value() -> PreProcessingParsedResponseTypeDef:
return {
"isValid": ...,
}
# PreProcessingParsedResponseTypeDef definition
class PreProcessingParsedResponseTypeDef(TypedDict):
isValid: NotRequired[bool],
rationale: NotRequired[str],ReasoningTextBlockTypeDef#
# ReasoningTextBlockTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ReasoningTextBlockTypeDef
def get_value() -> ReasoningTextBlockTypeDef:
return {
"signature": ...,
}
# ReasoningTextBlockTypeDef definition
class ReasoningTextBlockTypeDef(TypedDict):
text: str,
signature: NotRequired[str],RerankTextDocumentTypeDef#
# RerankTextDocumentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankTextDocumentTypeDef
def get_value() -> RerankTextDocumentTypeDef:
return {
"text": ...,
}
# RerankTextDocumentTypeDef definition
class RerankTextDocumentTypeDef(TypedDict):
text: NotRequired[str],RetrievalResultConfluenceLocationTypeDef#
# RetrievalResultConfluenceLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultConfluenceLocationTypeDef
def get_value() -> RetrievalResultConfluenceLocationTypeDef:
return {
"url": ...,
}
# RetrievalResultConfluenceLocationTypeDef definition
class RetrievalResultConfluenceLocationTypeDef(TypedDict):
url: NotRequired[str],RetrievalResultContentColumnTypeDef#
# RetrievalResultContentColumnTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultContentColumnTypeDef
def get_value() -> RetrievalResultContentColumnTypeDef:
return {
"columnName": ...,
}
# RetrievalResultContentColumnTypeDef definition
class RetrievalResultContentColumnTypeDef(TypedDict):
columnName: NotRequired[str],
columnValue: NotRequired[str],
type: NotRequired[RetrievalResultContentColumnTypeType], # (1)RetrievalResultCustomDocumentLocationTypeDef#
# RetrievalResultCustomDocumentLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultCustomDocumentLocationTypeDef
def get_value() -> RetrievalResultCustomDocumentLocationTypeDef:
return {
"id": ...,
}
# RetrievalResultCustomDocumentLocationTypeDef definition
class RetrievalResultCustomDocumentLocationTypeDef(TypedDict):
id: NotRequired[str],RetrievalResultKendraDocumentLocationTypeDef#
# RetrievalResultKendraDocumentLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultKendraDocumentLocationTypeDef
def get_value() -> RetrievalResultKendraDocumentLocationTypeDef:
return {
"uri": ...,
}
# RetrievalResultKendraDocumentLocationTypeDef definition
class RetrievalResultKendraDocumentLocationTypeDef(TypedDict):
uri: NotRequired[str],RetrievalResultS3LocationTypeDef#
# RetrievalResultS3LocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultS3LocationTypeDef
def get_value() -> RetrievalResultS3LocationTypeDef:
return {
"uri": ...,
}
# RetrievalResultS3LocationTypeDef definition
class RetrievalResultS3LocationTypeDef(TypedDict):
uri: NotRequired[str],RetrievalResultSalesforceLocationTypeDef#
# RetrievalResultSalesforceLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultSalesforceLocationTypeDef
def get_value() -> RetrievalResultSalesforceLocationTypeDef:
return {
"url": ...,
}
# RetrievalResultSalesforceLocationTypeDef definition
class RetrievalResultSalesforceLocationTypeDef(TypedDict):
url: NotRequired[str],RetrievalResultSharePointLocationTypeDef#
# RetrievalResultSharePointLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultSharePointLocationTypeDef
def get_value() -> RetrievalResultSharePointLocationTypeDef:
return {
"url": ...,
}
# RetrievalResultSharePointLocationTypeDef definition
class RetrievalResultSharePointLocationTypeDef(TypedDict):
url: NotRequired[str],RetrievalResultSqlLocationTypeDef#
# RetrievalResultSqlLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultSqlLocationTypeDef
def get_value() -> RetrievalResultSqlLocationTypeDef:
return {
"query": ...,
}
# RetrievalResultSqlLocationTypeDef definition
class RetrievalResultSqlLocationTypeDef(TypedDict):
query: NotRequired[str],RetrievalResultWebLocationTypeDef#
# RetrievalResultWebLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultWebLocationTypeDef
def get_value() -> RetrievalResultWebLocationTypeDef:
return {
"url": ...,
}
# RetrievalResultWebLocationTypeDef definition
class RetrievalResultWebLocationTypeDef(TypedDict):
url: NotRequired[str],RetrieveAndGenerateInputTypeDef#
# RetrieveAndGenerateInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateInputTypeDef
def get_value() -> RetrieveAndGenerateInputTypeDef:
return {
"text": ...,
}
# RetrieveAndGenerateInputTypeDef definition
class RetrieveAndGenerateInputTypeDef(TypedDict):
text: str,RetrieveAndGenerateOutputEventTypeDef#
# RetrieveAndGenerateOutputEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateOutputEventTypeDef
def get_value() -> RetrieveAndGenerateOutputEventTypeDef:
return {
"text": ...,
}
# RetrieveAndGenerateOutputEventTypeDef definition
class RetrieveAndGenerateOutputEventTypeDef(TypedDict):
text: str,RetrieveAndGenerateOutputTypeDef#
# RetrieveAndGenerateOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateOutputTypeDef
def get_value() -> RetrieveAndGenerateOutputTypeDef:
return {
"text": ...,
}
# RetrieveAndGenerateOutputTypeDef definition
class RetrieveAndGenerateOutputTypeDef(TypedDict):
text: str,RetrieveAndGenerateSessionConfigurationTypeDef#
# RetrieveAndGenerateSessionConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateSessionConfigurationTypeDef
def get_value() -> RetrieveAndGenerateSessionConfigurationTypeDef:
return {
"kmsKeyArn": ...,
}
# RetrieveAndGenerateSessionConfigurationTypeDef definition
class RetrieveAndGenerateSessionConfigurationTypeDef(TypedDict):
kmsKeyArn: str,SpanTypeDef#
# SpanTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import SpanTypeDef
def get_value() -> SpanTypeDef:
return {
"end": ...,
}
# SpanTypeDef definition
class SpanTypeDef(TypedDict):
end: NotRequired[int],
start: NotRequired[int],TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],TextToSqlKnowledgeBaseConfigurationTypeDef#
# TextToSqlKnowledgeBaseConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TextToSqlKnowledgeBaseConfigurationTypeDef
def get_value() -> TextToSqlKnowledgeBaseConfigurationTypeDef:
return {
"knowledgeBaseArn": ...,
}
# TextToSqlKnowledgeBaseConfigurationTypeDef definition
class TextToSqlKnowledgeBaseConfigurationTypeDef(TypedDict):
knowledgeBaseArn: str,UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],UpdateSessionRequestTypeDef#
# UpdateSessionRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import UpdateSessionRequestTypeDef
def get_value() -> UpdateSessionRequestTypeDef:
return {
"sessionIdentifier": ...,
}
# UpdateSessionRequestTypeDef definition
class UpdateSessionRequestTypeDef(TypedDict):
sessionIdentifier: str,
sessionMetadata: NotRequired[Mapping[str, str]],VectorSearchBedrockRerankingModelConfigurationTypeDef#
# VectorSearchBedrockRerankingModelConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import VectorSearchBedrockRerankingModelConfigurationTypeDef
def get_value() -> VectorSearchBedrockRerankingModelConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# VectorSearchBedrockRerankingModelConfigurationTypeDef definition
class VectorSearchBedrockRerankingModelConfigurationTypeDef(TypedDict):
modelArn: str,
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],APISchemaTypeDef#
# APISchemaTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import APISchemaTypeDef
def get_value() -> APISchemaTypeDef:
return {
"payload": ...,
}
# APISchemaTypeDef definition
class APISchemaTypeDef(TypedDict):
payload: NotRequired[str],
s3: NotRequired[S3IdentifierTypeDef], # (1)PropertyParametersTypeDef#
# PropertyParametersTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PropertyParametersTypeDef
def get_value() -> PropertyParametersTypeDef:
return {
"properties": ...,
}
# PropertyParametersTypeDef definition
class PropertyParametersTypeDef(TypedDict):
properties: NotRequired[List[ParameterTypeDef]], # (1)- See
List[ParameterTypeDef]
RequestBodyTypeDef#
# RequestBodyTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RequestBodyTypeDef
def get_value() -> RequestBodyTypeDef:
return {
"content": ...,
}
# RequestBodyTypeDef definition
class RequestBodyTypeDef(TypedDict):
content: NotRequired[Dict[str, List[ParameterTypeDef]]], # (1)- See
Dict[str, List[ParameterTypeDef]]
BedrockModelConfigurationsTypeDef#
# BedrockModelConfigurationsTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BedrockModelConfigurationsTypeDef
def get_value() -> BedrockModelConfigurationsTypeDef:
return {
"performanceConfig": ...,
}
# BedrockModelConfigurationsTypeDef definition
class BedrockModelConfigurationsTypeDef(TypedDict):
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (1)InlineBedrockModelConfigurationsTypeDef#
# InlineBedrockModelConfigurationsTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineBedrockModelConfigurationsTypeDef
def get_value() -> InlineBedrockModelConfigurationsTypeDef:
return {
"performanceConfig": ...,
}
# InlineBedrockModelConfigurationsTypeDef definition
class InlineBedrockModelConfigurationsTypeDef(TypedDict):
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (1)ModelPerformanceConfigurationTypeDef#
# ModelPerformanceConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ModelPerformanceConfigurationTypeDef
def get_value() -> ModelPerformanceConfigurationTypeDef:
return {
"performanceConfig": ...,
}
# ModelPerformanceConfigurationTypeDef definition
class ModelPerformanceConfigurationTypeDef(TypedDict):
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (1)BedrockRerankingConfigurationTypeDef#
# BedrockRerankingConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BedrockRerankingConfigurationTypeDef
def get_value() -> BedrockRerankingConfigurationTypeDef:
return {
"modelConfiguration": ...,
}
# BedrockRerankingConfigurationTypeDef definition
class BedrockRerankingConfigurationTypeDef(TypedDict):
modelConfiguration: BedrockRerankingModelConfigurationTypeDef, # (1)
numberOfResults: NotRequired[int],ByteContentDocTypeDef#
# ByteContentDocTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ByteContentDocTypeDef
def get_value() -> ByteContentDocTypeDef:
return {
"contentType": ...,
}
# ByteContentDocTypeDef definition
class ByteContentDocTypeDef(TypedDict):
contentType: str,
data: BlobTypeDef,
identifier: str,ByteContentFileTypeDef#
# ByteContentFileTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ByteContentFileTypeDef
def get_value() -> ByteContentFileTypeDef:
return {
"data": ...,
}
# ByteContentFileTypeDef definition
class ByteContentFileTypeDef(TypedDict):
data: BlobTypeDef,
mediaType: str,ImageInputSourceTypeDef#
# ImageInputSourceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputSourceTypeDef
def get_value() -> ImageInputSourceTypeDef:
return {
"bytes": ...,
}
# ImageInputSourceTypeDef definition
class ImageInputSourceTypeDef(TypedDict):
bytes: NotRequired[BlobTypeDef],MessageTypeDef#
# MessageTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MessageTypeDef
def get_value() -> MessageTypeDef:
return {
"content": ...,
}
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
content: Sequence[ContentBlockTypeDef], # (1)
role: ConversationRoleType, # (2)- See
Sequence[ContentBlockTypeDef] - See ConversationRoleType
CreateInvocationResponseTypeDef#
# CreateInvocationResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CreateInvocationResponseTypeDef
def get_value() -> CreateInvocationResponseTypeDef:
return {
"createdAt": ...,
}
# CreateInvocationResponseTypeDef definition
class CreateInvocationResponseTypeDef(TypedDict):
createdAt: datetime.datetime,
invocationId: str,
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateSessionResponseTypeDef#
# CreateSessionResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CreateSessionResponseTypeDef
def get_value() -> CreateSessionResponseTypeDef:
return {
"createdAt": ...,
}
# CreateSessionResponseTypeDef definition
class CreateSessionResponseTypeDef(TypedDict):
createdAt: datetime.datetime,
sessionArn: str,
sessionId: str,
sessionStatus: SessionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)EndSessionResponseTypeDef#
# EndSessionResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import EndSessionResponseTypeDef
def get_value() -> EndSessionResponseTypeDef:
return {
"sessionArn": ...,
}
# EndSessionResponseTypeDef definition
class EndSessionResponseTypeDef(TypedDict):
sessionArn: str,
sessionId: str,
sessionStatus: SessionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetSessionResponseTypeDef#
# GetSessionResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetSessionResponseTypeDef
def get_value() -> GetSessionResponseTypeDef:
return {
"createdAt": ...,
}
# GetSessionResponseTypeDef definition
class GetSessionResponseTypeDef(TypedDict):
createdAt: datetime.datetime,
encryptionKeyArn: str,
lastUpdatedAt: datetime.datetime,
sessionArn: str,
sessionId: str,
sessionMetadata: Dict[str, str],
sessionStatus: SessionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)PutInvocationStepResponseTypeDef#
# PutInvocationStepResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PutInvocationStepResponseTypeDef
def get_value() -> PutInvocationStepResponseTypeDef:
return {
"invocationStepId": ...,
}
# PutInvocationStepResponseTypeDef definition
class PutInvocationStepResponseTypeDef(TypedDict):
invocationStepId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateSessionResponseTypeDef#
# UpdateSessionResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import UpdateSessionResponseTypeDef
def get_value() -> UpdateSessionResponseTypeDef:
return {
"createdAt": ...,
}
# UpdateSessionResponseTypeDef definition
class UpdateSessionResponseTypeDef(TypedDict):
createdAt: datetime.datetime,
lastUpdatedAt: datetime.datetime,
sessionArn: str,
sessionId: str,
sessionStatus: SessionStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CustomOrchestrationTraceTypeDef#
# CustomOrchestrationTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CustomOrchestrationTraceTypeDef
def get_value() -> CustomOrchestrationTraceTypeDef:
return {
"event": ...,
}
# CustomOrchestrationTraceTypeDef definition
class CustomOrchestrationTraceTypeDef(TypedDict):
event: NotRequired[CustomOrchestrationTraceEventTypeDef], # (1)
traceId: NotRequired[str],RerankingMetadataSelectiveModeConfigurationTypeDef#
# RerankingMetadataSelectiveModeConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankingMetadataSelectiveModeConfigurationTypeDef
def get_value() -> RerankingMetadataSelectiveModeConfigurationTypeDef:
return {
"fieldsToExclude": ...,
}
# RerankingMetadataSelectiveModeConfigurationTypeDef definition
class RerankingMetadataSelectiveModeConfigurationTypeDef(TypedDict):
fieldsToExclude: NotRequired[Sequence[FieldForRerankingTypeDef]], # (1)
fieldsToInclude: NotRequired[Sequence[FieldForRerankingTypeDef]], # (1)- See
Sequence[FieldForRerankingTypeDef] - See
Sequence[FieldForRerankingTypeDef]
FilePartTypeDef#
# FilePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FilePartTypeDef
def get_value() -> FilePartTypeDef:
return {
"files": ...,
}
# FilePartTypeDef definition
class FilePartTypeDef(TypedDict):
files: NotRequired[List[OutputFileTypeDef]], # (1)- See
List[OutputFileTypeDef]
InlineAgentFilePartTypeDef#
# InlineAgentFilePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineAgentFilePartTypeDef
def get_value() -> InlineAgentFilePartTypeDef:
return {
"files": ...,
}
# InlineAgentFilePartTypeDef definition
class InlineAgentFilePartTypeDef(TypedDict):
files: NotRequired[List[OutputFileTypeDef]], # (1)- See
List[OutputFileTypeDef]
RetrievalFilterPaginatorTypeDef#
# RetrievalFilterPaginatorTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalFilterPaginatorTypeDef
def get_value() -> RetrievalFilterPaginatorTypeDef:
return {
"andAll": ...,
}
# RetrievalFilterPaginatorTypeDef definition
class RetrievalFilterPaginatorTypeDef(TypedDict):
andAll: NotRequired[Sequence[Mapping[str, Any]]],
equals: NotRequired[FilterAttributeTypeDef], # (1)
greaterThan: NotRequired[FilterAttributeTypeDef], # (1)
greaterThanOrEquals: NotRequired[FilterAttributeTypeDef], # (1)
in: NotRequired[FilterAttributeTypeDef], # (1)
lessThan: NotRequired[FilterAttributeTypeDef], # (1)
lessThanOrEquals: NotRequired[FilterAttributeTypeDef], # (1)
listContains: NotRequired[FilterAttributeTypeDef], # (1)
notEquals: NotRequired[FilterAttributeTypeDef], # (1)
notIn: NotRequired[FilterAttributeTypeDef], # (1)
orAll: NotRequired[Sequence[Mapping[str, Any]]],
startsWith: NotRequired[FilterAttributeTypeDef], # (1)
stringContains: NotRequired[FilterAttributeTypeDef], # (1)- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
RetrievalFilterTypeDef#
# RetrievalFilterTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalFilterTypeDef
def get_value() -> RetrievalFilterTypeDef:
return {
"andAll": ...,
}
# RetrievalFilterTypeDef definition
class RetrievalFilterTypeDef(TypedDict):
andAll: NotRequired[Sequence[Mapping[str, Any]]],
equals: NotRequired[FilterAttributeTypeDef], # (1)
greaterThan: NotRequired[FilterAttributeTypeDef], # (1)
greaterThanOrEquals: NotRequired[FilterAttributeTypeDef], # (1)
in: NotRequired[FilterAttributeTypeDef], # (1)
lessThan: NotRequired[FilterAttributeTypeDef], # (1)
lessThanOrEquals: NotRequired[FilterAttributeTypeDef], # (1)
listContains: NotRequired[FilterAttributeTypeDef], # (1)
notEquals: NotRequired[FilterAttributeTypeDef], # (1)
notIn: NotRequired[FilterAttributeTypeDef], # (1)
orAll: NotRequired[Sequence[Mapping[str, Any]]],
startsWith: NotRequired[FilterAttributeTypeDef], # (1)
stringContains: NotRequired[FilterAttributeTypeDef], # (1)- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
- See FilterAttributeTypeDef
FlowInputTypeDef#
# FlowInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowInputTypeDef
def get_value() -> FlowInputTypeDef:
return {
"content": ...,
}
# FlowInputTypeDef definition
class FlowInputTypeDef(TypedDict):
content: FlowInputContentTypeDef, # (1)
nodeName: str,
nodeInputName: NotRequired[str],
nodeOutputName: NotRequired[str],FlowMultiTurnInputRequestEventTypeDef#
# FlowMultiTurnInputRequestEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowMultiTurnInputRequestEventTypeDef
def get_value() -> FlowMultiTurnInputRequestEventTypeDef:
return {
"content": ...,
}
# FlowMultiTurnInputRequestEventTypeDef definition
class FlowMultiTurnInputRequestEventTypeDef(TypedDict):
content: FlowMultiTurnInputContentTypeDef, # (1)
nodeName: str,
nodeType: NodeTypeType, # (2)FlowOutputEventTypeDef#
# FlowOutputEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowOutputEventTypeDef
def get_value() -> FlowOutputEventTypeDef:
return {
"content": ...,
}
# FlowOutputEventTypeDef definition
class FlowOutputEventTypeDef(TypedDict):
content: FlowOutputContentTypeDef, # (1)
nodeName: str,
nodeType: NodeTypeType, # (2)- See FlowOutputContentTypeDef
- See NodeTypeType
FlowTraceConditionNodeResultEventTypeDef#
# FlowTraceConditionNodeResultEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceConditionNodeResultEventTypeDef
def get_value() -> FlowTraceConditionNodeResultEventTypeDef:
return {
"nodeName": ...,
}
# FlowTraceConditionNodeResultEventTypeDef definition
class FlowTraceConditionNodeResultEventTypeDef(TypedDict):
nodeName: str,
satisfiedConditions: List[FlowTraceConditionTypeDef], # (1)
timestamp: datetime.datetime,- See
List[FlowTraceConditionTypeDef]
FlowTraceNodeInputFieldTypeDef#
# FlowTraceNodeInputFieldTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeInputFieldTypeDef
def get_value() -> FlowTraceNodeInputFieldTypeDef:
return {
"content": ...,
}
# FlowTraceNodeInputFieldTypeDef definition
class FlowTraceNodeInputFieldTypeDef(TypedDict):
content: FlowTraceNodeInputContentTypeDef, # (1)
nodeInputName: str,FlowTraceNodeOutputFieldTypeDef#
# FlowTraceNodeOutputFieldTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeOutputFieldTypeDef
def get_value() -> FlowTraceNodeOutputFieldTypeDef:
return {
"content": ...,
}
# FlowTraceNodeOutputFieldTypeDef definition
class FlowTraceNodeOutputFieldTypeDef(TypedDict):
content: FlowTraceNodeOutputContentTypeDef, # (1)
nodeOutputName: str,FunctionDefinitionTypeDef#
# FunctionDefinitionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionDefinitionTypeDef
def get_value() -> FunctionDefinitionTypeDef:
return {
"description": ...,
}
# FunctionDefinitionTypeDef definition
class FunctionDefinitionTypeDef(TypedDict):
name: str,
description: NotRequired[str],
parameters: NotRequired[Mapping[str, ParameterDetailTypeDef]], # (1)
requireConfirmation: NotRequired[RequireConfirmationType], # (2)- See
Mapping[str, ParameterDetailTypeDef] - See RequireConfirmationType
FunctionInvocationInputTypeDef#
# FunctionInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionInvocationInputTypeDef
def get_value() -> FunctionInvocationInputTypeDef:
return {
"actionGroup": ...,
}
# FunctionInvocationInputTypeDef definition
class FunctionInvocationInputTypeDef(TypedDict):
actionGroup: str,
actionInvocationType: NotRequired[ActionInvocationTypeType], # (1)
agentId: NotRequired[str],
collaboratorName: NotRequired[str],
function: NotRequired[str],
parameters: NotRequired[List[FunctionParameterTypeDef]], # (2)- See ActionInvocationTypeType
- See
List[FunctionParameterTypeDef]
GenerateQueryResponseTypeDef#
# GenerateQueryResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GenerateQueryResponseTypeDef
def get_value() -> GenerateQueryResponseTypeDef:
return {
"queries": ...,
}
# GenerateQueryResponseTypeDef definition
class GenerateQueryResponseTypeDef(TypedDict):
queries: List[GeneratedQueryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[GeneratedQueryTypeDef] - See ResponseMetadataTypeDef
GetAgentMemoryRequestPaginateTypeDef#
# GetAgentMemoryRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetAgentMemoryRequestPaginateTypeDef
def get_value() -> GetAgentMemoryRequestPaginateTypeDef:
return {
"agentAliasId": ...,
}
# GetAgentMemoryRequestPaginateTypeDef definition
class GetAgentMemoryRequestPaginateTypeDef(TypedDict):
agentAliasId: str,
agentId: str,
memoryId: str,
memoryType: MemoryTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See MemoryTypeType
- See PaginatorConfigTypeDef
ListInvocationStepsRequestPaginateTypeDef#
# ListInvocationStepsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationStepsRequestPaginateTypeDef
def get_value() -> ListInvocationStepsRequestPaginateTypeDef:
return {
"sessionIdentifier": ...,
}
# ListInvocationStepsRequestPaginateTypeDef definition
class ListInvocationStepsRequestPaginateTypeDef(TypedDict):
sessionIdentifier: str,
invocationIdentifier: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListInvocationsRequestPaginateTypeDef#
# ListInvocationsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationsRequestPaginateTypeDef
def get_value() -> ListInvocationsRequestPaginateTypeDef:
return {
"sessionIdentifier": ...,
}
# ListInvocationsRequestPaginateTypeDef definition
class ListInvocationsRequestPaginateTypeDef(TypedDict):
sessionIdentifier: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSessionsRequestPaginateTypeDef#
# ListSessionsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListSessionsRequestPaginateTypeDef
def get_value() -> ListSessionsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListSessionsRequestPaginateTypeDef definition
class ListSessionsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)GuardrailContentPolicyAssessmentTypeDef#
# GuardrailContentPolicyAssessmentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailContentPolicyAssessmentTypeDef
def get_value() -> GuardrailContentPolicyAssessmentTypeDef:
return {
"filters": ...,
}
# GuardrailContentPolicyAssessmentTypeDef definition
class GuardrailContentPolicyAssessmentTypeDef(TypedDict):
filters: NotRequired[List[GuardrailContentFilterTypeDef]], # (1)- See
List[GuardrailContentFilterTypeDef]
GuardrailWordPolicyAssessmentTypeDef#
# GuardrailWordPolicyAssessmentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailWordPolicyAssessmentTypeDef
def get_value() -> GuardrailWordPolicyAssessmentTypeDef:
return {
"customWords": ...,
}
# GuardrailWordPolicyAssessmentTypeDef definition
class GuardrailWordPolicyAssessmentTypeDef(TypedDict):
customWords: NotRequired[List[GuardrailCustomWordTypeDef]], # (1)
managedWordLists: NotRequired[List[GuardrailManagedWordTypeDef]], # (2)- See
List[GuardrailCustomWordTypeDef] - See
List[GuardrailManagedWordTypeDef]
GuardrailSensitiveInformationPolicyAssessmentTypeDef#
# GuardrailSensitiveInformationPolicyAssessmentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailSensitiveInformationPolicyAssessmentTypeDef
def get_value() -> GuardrailSensitiveInformationPolicyAssessmentTypeDef:
return {
"piiEntities": ...,
}
# GuardrailSensitiveInformationPolicyAssessmentTypeDef definition
class GuardrailSensitiveInformationPolicyAssessmentTypeDef(TypedDict):
piiEntities: NotRequired[List[GuardrailPiiEntityFilterTypeDef]], # (1)
regexes: NotRequired[List[GuardrailRegexFilterTypeDef]], # (2)- See
List[GuardrailPiiEntityFilterTypeDef] - See
List[GuardrailRegexFilterTypeDef]
GuardrailTopicPolicyAssessmentTypeDef#
# GuardrailTopicPolicyAssessmentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailTopicPolicyAssessmentTypeDef
def get_value() -> GuardrailTopicPolicyAssessmentTypeDef:
return {
"topics": ...,
}
# GuardrailTopicPolicyAssessmentTypeDef definition
class GuardrailTopicPolicyAssessmentTypeDef(TypedDict):
topics: NotRequired[List[GuardrailTopicTypeDef]], # (1)- See
List[GuardrailTopicTypeDef]
ImageInputOutputTypeDef#
# ImageInputOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputOutputTypeDef
def get_value() -> ImageInputOutputTypeDef:
return {
"format": ...,
}
# ImageInputOutputTypeDef definition
class ImageInputOutputTypeDef(TypedDict):
format: ImageInputFormatType, # (1)
source: ImageInputSourceOutputTypeDef, # (2)ImageSourceOutputTypeDef#
# ImageSourceOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageSourceOutputTypeDef
def get_value() -> ImageSourceOutputTypeDef:
return {
"bytes": ...,
}
# ImageSourceOutputTypeDef definition
class ImageSourceOutputTypeDef(TypedDict):
bytes: NotRequired[bytes],
s3Location: NotRequired[S3LocationTypeDef], # (1)ImageSourceTypeDef#
# ImageSourceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageSourceTypeDef
def get_value() -> ImageSourceTypeDef:
return {
"bytes": ...,
}
# ImageSourceTypeDef definition
class ImageSourceTypeDef(TypedDict):
bytes: NotRequired[BlobTypeDef],
s3Location: NotRequired[S3LocationTypeDef], # (1)ImplicitFilterConfigurationTypeDef#
# ImplicitFilterConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImplicitFilterConfigurationTypeDef
def get_value() -> ImplicitFilterConfigurationTypeDef:
return {
"metadataAttributes": ...,
}
# ImplicitFilterConfigurationTypeDef definition
class ImplicitFilterConfigurationTypeDef(TypedDict):
metadataAttributes: Sequence[MetadataAttributeSchemaTypeDef], # (1)
modelArn: str,- See
Sequence[MetadataAttributeSchemaTypeDef]
InferenceConfigTypeDef#
# InferenceConfigTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InferenceConfigTypeDef
def get_value() -> InferenceConfigTypeDef:
return {
"textInferenceConfig": ...,
}
# InferenceConfigTypeDef definition
class InferenceConfigTypeDef(TypedDict):
textInferenceConfig: NotRequired[TextInferenceConfigTypeDef], # (1)ModelInvocationInputTypeDef#
# ModelInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ModelInvocationInputTypeDef
def get_value() -> ModelInvocationInputTypeDef:
return {
"foundationModel": ...,
}
# ModelInvocationInputTypeDef definition
class ModelInvocationInputTypeDef(TypedDict):
foundationModel: NotRequired[str],
inferenceConfiguration: NotRequired[InferenceConfigurationOutputTypeDef], # (1)
overrideLambda: NotRequired[str],
parserMode: NotRequired[CreationModeType], # (2)
promptCreationMode: NotRequired[CreationModeType], # (2)
text: NotRequired[str],
traceId: NotRequired[str],
type: NotRequired[PromptTypeType], # (4)- See InferenceConfigurationOutputTypeDef
- See CreationModeType
- See CreationModeType
- See PromptTypeType
InputPromptTypeDef#
# InputPromptTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InputPromptTypeDef
def get_value() -> InputPromptTypeDef:
return {
"textPrompt": ...,
}
# InputPromptTypeDef definition
class InputPromptTypeDef(TypedDict):
textPrompt: NotRequired[TextPromptTypeDef], # (1)OptimizedPromptTypeDef#
# OptimizedPromptTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OptimizedPromptTypeDef
def get_value() -> OptimizedPromptTypeDef:
return {
"textPrompt": ...,
}
# OptimizedPromptTypeDef definition
class OptimizedPromptTypeDef(TypedDict):
textPrompt: NotRequired[TextPromptTypeDef], # (1)ListInvocationStepsResponseTypeDef#
# ListInvocationStepsResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationStepsResponseTypeDef
def get_value() -> ListInvocationStepsResponseTypeDef:
return {
"invocationStepSummaries": ...,
}
# ListInvocationStepsResponseTypeDef definition
class ListInvocationStepsResponseTypeDef(TypedDict):
invocationStepSummaries: List[InvocationStepSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[InvocationStepSummaryTypeDef] - See ResponseMetadataTypeDef
ListInvocationsResponseTypeDef#
# ListInvocationsResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListInvocationsResponseTypeDef
def get_value() -> ListInvocationsResponseTypeDef:
return {
"invocationSummaries": ...,
}
# ListInvocationsResponseTypeDef definition
class ListInvocationsResponseTypeDef(TypedDict):
invocationSummaries: List[InvocationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[InvocationSummaryTypeDef] - See ResponseMetadataTypeDef
ListSessionsResponseTypeDef#
# ListSessionsResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ListSessionsResponseTypeDef
def get_value() -> ListSessionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListSessionsResponseTypeDef definition
class ListSessionsResponseTypeDef(TypedDict):
sessionSummaries: List[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[SessionSummaryTypeDef] - See ResponseMetadataTypeDef
MemoryTypeDef#
# MemoryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MemoryTypeDef
def get_value() -> MemoryTypeDef:
return {
"sessionSummary": ...,
}
# MemoryTypeDef definition
class MemoryTypeDef(TypedDict):
sessionSummary: NotRequired[MemorySessionSummaryTypeDef], # (1)MetadataTypeDef#
# MetadataTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MetadataTypeDef
def get_value() -> MetadataTypeDef:
return {
"usage": ...,
}
# MetadataTypeDef definition
class MetadataTypeDef(TypedDict):
usage: NotRequired[UsageTypeDef], # (1)- See UsageTypeDef
ReasoningContentBlockTypeDef#
# ReasoningContentBlockTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ReasoningContentBlockTypeDef
def get_value() -> ReasoningContentBlockTypeDef:
return {
"reasoningText": ...,
}
# ReasoningContentBlockTypeDef definition
class ReasoningContentBlockTypeDef(TypedDict):
reasoningText: NotRequired[ReasoningTextBlockTypeDef], # (1)
redactedContent: NotRequired[bytes],RerankDocumentOutputTypeDef#
# RerankDocumentOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankDocumentOutputTypeDef
def get_value() -> RerankDocumentOutputTypeDef:
return {
"jsonDocument": ...,
}
# RerankDocumentOutputTypeDef definition
class RerankDocumentOutputTypeDef(TypedDict):
type: RerankDocumentTypeType, # (2)
jsonDocument: NotRequired[Dict[str, Any]],
textDocument: NotRequired[RerankTextDocumentTypeDef], # (1)RerankDocumentTypeDef#
# RerankDocumentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankDocumentTypeDef
def get_value() -> RerankDocumentTypeDef:
return {
"jsonDocument": ...,
}
# RerankDocumentTypeDef definition
class RerankDocumentTypeDef(TypedDict):
type: RerankDocumentTypeType, # (2)
jsonDocument: NotRequired[Mapping[str, Any]],
textDocument: NotRequired[RerankTextDocumentTypeDef], # (1)RerankQueryTypeDef#
# RerankQueryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankQueryTypeDef
def get_value() -> RerankQueryTypeDef:
return {
"textQuery": ...,
}
# RerankQueryTypeDef definition
class RerankQueryTypeDef(TypedDict):
textQuery: RerankTextDocumentTypeDef, # (1)
type: RerankQueryContentTypeType, # (2)RetrievalResultContentTypeDef#
# RetrievalResultContentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultContentTypeDef
def get_value() -> RetrievalResultContentTypeDef:
return {
"byteContent": ...,
}
# RetrievalResultContentTypeDef definition
class RetrievalResultContentTypeDef(TypedDict):
byteContent: NotRequired[str],
row: NotRequired[List[RetrievalResultContentColumnTypeDef]], # (1)
text: NotRequired[str],
type: NotRequired[RetrievalResultContentTypeType], # (2)- See
List[RetrievalResultContentColumnTypeDef] - See RetrievalResultContentTypeType
RetrievalResultLocationTypeDef#
# RetrievalResultLocationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievalResultLocationTypeDef
def get_value() -> RetrievalResultLocationTypeDef:
return {
"confluenceLocation": ...,
}
# RetrievalResultLocationTypeDef definition
class RetrievalResultLocationTypeDef(TypedDict):
type: RetrievalResultLocationTypeType, # (8)
confluenceLocation: NotRequired[RetrievalResultConfluenceLocationTypeDef], # (1)
customDocumentLocation: NotRequired[RetrievalResultCustomDocumentLocationTypeDef], # (2)
kendraDocumentLocation: NotRequired[RetrievalResultKendraDocumentLocationTypeDef], # (3)
s3Location: NotRequired[RetrievalResultS3LocationTypeDef], # (4)
salesforceLocation: NotRequired[RetrievalResultSalesforceLocationTypeDef], # (5)
sharePointLocation: NotRequired[RetrievalResultSharePointLocationTypeDef], # (6)
sqlLocation: NotRequired[RetrievalResultSqlLocationTypeDef], # (7)
webLocation: NotRequired[RetrievalResultWebLocationTypeDef], # (9)- See RetrievalResultConfluenceLocationTypeDef
- See RetrievalResultCustomDocumentLocationTypeDef
- See RetrievalResultKendraDocumentLocationTypeDef
- See RetrievalResultS3LocationTypeDef
- See RetrievalResultSalesforceLocationTypeDef
- See RetrievalResultSharePointLocationTypeDef
- See RetrievalResultSqlLocationTypeDef
- See RetrievalResultLocationTypeType
- See RetrievalResultWebLocationTypeDef
TextResponsePartTypeDef#
# TextResponsePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TextResponsePartTypeDef
def get_value() -> TextResponsePartTypeDef:
return {
"span": ...,
}
# TextResponsePartTypeDef definition
class TextResponsePartTypeDef(TypedDict):
span: NotRequired[SpanTypeDef], # (1)
text: NotRequired[str],- See SpanTypeDef
TextToSqlConfigurationTypeDef#
# TextToSqlConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TextToSqlConfigurationTypeDef
def get_value() -> TextToSqlConfigurationTypeDef:
return {
"knowledgeBaseConfiguration": ...,
}
# TextToSqlConfigurationTypeDef definition
class TextToSqlConfigurationTypeDef(TypedDict):
type: TextToSqlConfigurationTypeType, # (2)
knowledgeBaseConfiguration: NotRequired[TextToSqlKnowledgeBaseConfigurationTypeDef], # (1)ApiRequestBodyTypeDef#
# ApiRequestBodyTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiRequestBodyTypeDef
def get_value() -> ApiRequestBodyTypeDef:
return {
"content": ...,
}
# ApiRequestBodyTypeDef definition
class ApiRequestBodyTypeDef(TypedDict):
content: NotRequired[Dict[str, PropertyParametersTypeDef]], # (1)- See
Dict[str, PropertyParametersTypeDef]
ActionGroupInvocationInputTypeDef#
# ActionGroupInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ActionGroupInvocationInputTypeDef
def get_value() -> ActionGroupInvocationInputTypeDef:
return {
"actionGroupName": ...,
}
# ActionGroupInvocationInputTypeDef definition
class ActionGroupInvocationInputTypeDef(TypedDict):
actionGroupName: NotRequired[str],
apiPath: NotRequired[str],
executionType: NotRequired[ExecutionTypeType], # (1)
function: NotRequired[str],
invocationId: NotRequired[str],
parameters: NotRequired[List[ParameterTypeDef]], # (2)
requestBody: NotRequired[RequestBodyTypeDef], # (3)
verb: NotRequired[str],- See ExecutionTypeType
- See
List[ParameterTypeDef] - See RequestBodyTypeDef
RerankingConfigurationTypeDef#
# RerankingConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankingConfigurationTypeDef
def get_value() -> RerankingConfigurationTypeDef:
return {
"bedrockRerankingConfiguration": ...,
}
# RerankingConfigurationTypeDef definition
class RerankingConfigurationTypeDef(TypedDict):
bedrockRerankingConfiguration: BedrockRerankingConfigurationTypeDef, # (1)
type: RerankingConfigurationTypeType, # (2)ExternalSourceTypeDef#
# ExternalSourceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ExternalSourceTypeDef
def get_value() -> ExternalSourceTypeDef:
return {
"byteContent": ...,
}
# ExternalSourceTypeDef definition
class ExternalSourceTypeDef(TypedDict):
sourceType: ExternalSourceTypeType, # (3)
byteContent: NotRequired[ByteContentDocTypeDef], # (1)
s3Location: NotRequired[S3ObjectDocTypeDef], # (2)FileSourceTypeDef#
# FileSourceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FileSourceTypeDef
def get_value() -> FileSourceTypeDef:
return {
"byteContent": ...,
}
# FileSourceTypeDef definition
class FileSourceTypeDef(TypedDict):
sourceType: FileSourceTypeType, # (3)
byteContent: NotRequired[ByteContentFileTypeDef], # (1)
s3Location: NotRequired[S3ObjectFileTypeDef], # (2)ConversationHistoryTypeDef#
# ConversationHistoryTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ConversationHistoryTypeDef
def get_value() -> ConversationHistoryTypeDef:
return {
"messages": ...,
}
# ConversationHistoryTypeDef definition
class ConversationHistoryTypeDef(TypedDict):
messages: NotRequired[Sequence[MessageTypeDef]], # (1)- See
Sequence[MessageTypeDef]
MetadataConfigurationForRerankingTypeDef#
# MetadataConfigurationForRerankingTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import MetadataConfigurationForRerankingTypeDef
def get_value() -> MetadataConfigurationForRerankingTypeDef:
return {
"selectionMode": ...,
}
# MetadataConfigurationForRerankingTypeDef definition
class MetadataConfigurationForRerankingTypeDef(TypedDict):
selectionMode: RerankingMetadataSelectionModeType, # (1)
selectiveModeConfiguration: NotRequired[RerankingMetadataSelectiveModeConfigurationTypeDef], # (2)InvokeFlowRequestTypeDef#
# InvokeFlowRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeFlowRequestTypeDef
def get_value() -> InvokeFlowRequestTypeDef:
return {
"flowAliasIdentifier": ...,
}
# InvokeFlowRequestTypeDef definition
class InvokeFlowRequestTypeDef(TypedDict):
flowAliasIdentifier: str,
flowIdentifier: str,
inputs: Sequence[FlowInputTypeDef], # (1)
enableTrace: NotRequired[bool],
executionId: NotRequired[str],
modelPerformanceConfiguration: NotRequired[ModelPerformanceConfigurationTypeDef], # (2)- See
Sequence[FlowInputTypeDef] - See ModelPerformanceConfigurationTypeDef
FlowTraceNodeInputEventTypeDef#
# FlowTraceNodeInputEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeInputEventTypeDef
def get_value() -> FlowTraceNodeInputEventTypeDef:
return {
"fields": ...,
}
# FlowTraceNodeInputEventTypeDef definition
class FlowTraceNodeInputEventTypeDef(TypedDict):
fields: List[FlowTraceNodeInputFieldTypeDef], # (1)
nodeName: str,
timestamp: datetime.datetime,- See
List[FlowTraceNodeInputFieldTypeDef]
FlowTraceNodeOutputEventTypeDef#
# FlowTraceNodeOutputEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceNodeOutputEventTypeDef
def get_value() -> FlowTraceNodeOutputEventTypeDef:
return {
"fields": ...,
}
# FlowTraceNodeOutputEventTypeDef definition
class FlowTraceNodeOutputEventTypeDef(TypedDict):
fields: List[FlowTraceNodeOutputFieldTypeDef], # (1)
nodeName: str,
timestamp: datetime.datetime,- See
List[FlowTraceNodeOutputFieldTypeDef]
FunctionSchemaTypeDef#
# FunctionSchemaTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionSchemaTypeDef
def get_value() -> FunctionSchemaTypeDef:
return {
"functions": ...,
}
# FunctionSchemaTypeDef definition
class FunctionSchemaTypeDef(TypedDict):
functions: NotRequired[Sequence[FunctionDefinitionTypeDef]], # (1)- See
Sequence[FunctionDefinitionTypeDef]
GuardrailAssessmentTypeDef#
# GuardrailAssessmentTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailAssessmentTypeDef
def get_value() -> GuardrailAssessmentTypeDef:
return {
"contentPolicy": ...,
}
# GuardrailAssessmentTypeDef definition
class GuardrailAssessmentTypeDef(TypedDict):
contentPolicy: NotRequired[GuardrailContentPolicyAssessmentTypeDef], # (1)
sensitiveInformationPolicy: NotRequired[GuardrailSensitiveInformationPolicyAssessmentTypeDef], # (2)
topicPolicy: NotRequired[GuardrailTopicPolicyAssessmentTypeDef], # (3)
wordPolicy: NotRequired[GuardrailWordPolicyAssessmentTypeDef], # (4)- See GuardrailContentPolicyAssessmentTypeDef
- See GuardrailSensitiveInformationPolicyAssessmentTypeDef
- See GuardrailTopicPolicyAssessmentTypeDef
- See GuardrailWordPolicyAssessmentTypeDef
ContentBodyOutputTypeDef#
# ContentBodyOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ContentBodyOutputTypeDef
def get_value() -> ContentBodyOutputTypeDef:
return {
"body": ...,
}
# ContentBodyOutputTypeDef definition
class ContentBodyOutputTypeDef(TypedDict):
body: NotRequired[str],
images: NotRequired[List[ImageInputOutputTypeDef]], # (1)- See
List[ImageInputOutputTypeDef]
ImageBlockOutputTypeDef#
# ImageBlockOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageBlockOutputTypeDef
def get_value() -> ImageBlockOutputTypeDef:
return {
"format": ...,
}
# ImageBlockOutputTypeDef definition
class ImageBlockOutputTypeDef(TypedDict):
format: ImageFormatType, # (1)
source: ImageSourceOutputTypeDef, # (2)ImageBlockTypeDef#
# ImageBlockTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageBlockTypeDef
def get_value() -> ImageBlockTypeDef:
return {
"format": ...,
}
# ImageBlockTypeDef definition
class ImageBlockTypeDef(TypedDict):
format: ImageFormatType, # (1)
source: ImageSourceTypeDef, # (2)- See ImageFormatType
- See ImageSourceTypeDef
ExternalSourcesGenerationConfigurationTypeDef#
# ExternalSourcesGenerationConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ExternalSourcesGenerationConfigurationTypeDef
def get_value() -> ExternalSourcesGenerationConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# ExternalSourcesGenerationConfigurationTypeDef definition
class ExternalSourcesGenerationConfigurationTypeDef(TypedDict):
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (1)
inferenceConfig: NotRequired[InferenceConfigTypeDef], # (2)
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (3)
promptTemplate: NotRequired[PromptTemplateTypeDef], # (4)- See GuardrailConfigurationTypeDef
- See InferenceConfigTypeDef
- See PerformanceConfigurationTypeDef
- See PromptTemplateTypeDef
GenerationConfigurationTypeDef#
# GenerationConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GenerationConfigurationTypeDef
def get_value() -> GenerationConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# GenerationConfigurationTypeDef definition
class GenerationConfigurationTypeDef(TypedDict):
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (1)
inferenceConfig: NotRequired[InferenceConfigTypeDef], # (2)
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (3)
promptTemplate: NotRequired[PromptTemplateTypeDef], # (4)- See GuardrailConfigurationTypeDef
- See InferenceConfigTypeDef
- See PerformanceConfigurationTypeDef
- See PromptTemplateTypeDef
OrchestrationConfigurationTypeDef#
# OrchestrationConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OrchestrationConfigurationTypeDef
def get_value() -> OrchestrationConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# OrchestrationConfigurationTypeDef definition
class OrchestrationConfigurationTypeDef(TypedDict):
additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
inferenceConfig: NotRequired[InferenceConfigTypeDef], # (1)
performanceConfig: NotRequired[PerformanceConfigurationTypeDef], # (2)
promptTemplate: NotRequired[PromptTemplateTypeDef], # (3)
queryTransformationConfiguration: NotRequired[QueryTransformationConfigurationTypeDef], # (4)- See InferenceConfigTypeDef
- See PerformanceConfigurationTypeDef
- See PromptTemplateTypeDef
- See QueryTransformationConfigurationTypeDef
PromptConfigurationTypeDef#
# PromptConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PromptConfigurationTypeDef
def get_value() -> PromptConfigurationTypeDef:
return {
"additionalModelRequestFields": ...,
}
# PromptConfigurationTypeDef definition
class PromptConfigurationTypeDef(TypedDict):
additionalModelRequestFields: NotRequired[Mapping[str, Any]],
basePromptTemplate: NotRequired[str],
foundationModel: NotRequired[str],
inferenceConfiguration: NotRequired[InferenceConfigurationUnionTypeDef], # (1)
parserMode: NotRequired[CreationModeType], # (2)
promptCreationMode: NotRequired[CreationModeType], # (2)
promptState: NotRequired[PromptStateType], # (4)
promptType: NotRequired[PromptTypeType], # (5)- See InferenceConfigurationUnionTypeDef
- See CreationModeType
- See CreationModeType
- See PromptStateType
- See PromptTypeType
OptimizePromptRequestTypeDef#
# OptimizePromptRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OptimizePromptRequestTypeDef
def get_value() -> OptimizePromptRequestTypeDef:
return {
"input": ...,
}
# OptimizePromptRequestTypeDef definition
class OptimizePromptRequestTypeDef(TypedDict):
input: InputPromptTypeDef, # (1)
targetModelId: str,OptimizedPromptEventTypeDef#
# OptimizedPromptEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OptimizedPromptEventTypeDef
def get_value() -> OptimizedPromptEventTypeDef:
return {
"optimizedPrompt": ...,
}
# OptimizedPromptEventTypeDef definition
class OptimizedPromptEventTypeDef(TypedDict):
optimizedPrompt: NotRequired[OptimizedPromptTypeDef], # (1)GetAgentMemoryResponseTypeDef#
# GetAgentMemoryResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetAgentMemoryResponseTypeDef
def get_value() -> GetAgentMemoryResponseTypeDef:
return {
"memoryContents": ...,
}
# GetAgentMemoryResponseTypeDef definition
class GetAgentMemoryResponseTypeDef(TypedDict):
memoryContents: List[MemoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[MemoryTypeDef] - See ResponseMetadataTypeDef
RoutingClassifierModelInvocationOutputTypeDef#
# RoutingClassifierModelInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RoutingClassifierModelInvocationOutputTypeDef
def get_value() -> RoutingClassifierModelInvocationOutputTypeDef:
return {
"metadata": ...,
}
# RoutingClassifierModelInvocationOutputTypeDef definition
class RoutingClassifierModelInvocationOutputTypeDef(TypedDict):
metadata: NotRequired[MetadataTypeDef], # (1)
rawResponse: NotRequired[RawResponseTypeDef], # (2)
traceId: NotRequired[str],- See MetadataTypeDef
- See RawResponseTypeDef
OrchestrationModelInvocationOutputTypeDef#
# OrchestrationModelInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OrchestrationModelInvocationOutputTypeDef
def get_value() -> OrchestrationModelInvocationOutputTypeDef:
return {
"metadata": ...,
}
# OrchestrationModelInvocationOutputTypeDef definition
class OrchestrationModelInvocationOutputTypeDef(TypedDict):
metadata: NotRequired[MetadataTypeDef], # (1)
rawResponse: NotRequired[RawResponseTypeDef], # (2)
reasoningContent: NotRequired[ReasoningContentBlockTypeDef], # (3)
traceId: NotRequired[str],PostProcessingModelInvocationOutputTypeDef#
# PostProcessingModelInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PostProcessingModelInvocationOutputTypeDef
def get_value() -> PostProcessingModelInvocationOutputTypeDef:
return {
"metadata": ...,
}
# PostProcessingModelInvocationOutputTypeDef definition
class PostProcessingModelInvocationOutputTypeDef(TypedDict):
metadata: NotRequired[MetadataTypeDef], # (1)
parsedResponse: NotRequired[PostProcessingParsedResponseTypeDef], # (2)
rawResponse: NotRequired[RawResponseTypeDef], # (3)
reasoningContent: NotRequired[ReasoningContentBlockTypeDef], # (4)
traceId: NotRequired[str],- See MetadataTypeDef
- See PostProcessingParsedResponseTypeDef
- See RawResponseTypeDef
- See ReasoningContentBlockTypeDef
PreProcessingModelInvocationOutputTypeDef#
# PreProcessingModelInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PreProcessingModelInvocationOutputTypeDef
def get_value() -> PreProcessingModelInvocationOutputTypeDef:
return {
"metadata": ...,
}
# PreProcessingModelInvocationOutputTypeDef definition
class PreProcessingModelInvocationOutputTypeDef(TypedDict):
metadata: NotRequired[MetadataTypeDef], # (1)
parsedResponse: NotRequired[PreProcessingParsedResponseTypeDef], # (2)
rawResponse: NotRequired[RawResponseTypeDef], # (3)
reasoningContent: NotRequired[ReasoningContentBlockTypeDef], # (4)
traceId: NotRequired[str],- See MetadataTypeDef
- See PreProcessingParsedResponseTypeDef
- See RawResponseTypeDef
- See ReasoningContentBlockTypeDef
RerankResultTypeDef#
# RerankResultTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankResultTypeDef
def get_value() -> RerankResultTypeDef:
return {
"document": ...,
}
# RerankResultTypeDef definition
class RerankResultTypeDef(TypedDict):
index: int,
relevanceScore: float,
document: NotRequired[RerankDocumentOutputTypeDef], # (1)KnowledgeBaseRetrievalResultTypeDef#
# KnowledgeBaseRetrievalResultTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseRetrievalResultTypeDef
def get_value() -> KnowledgeBaseRetrievalResultTypeDef:
return {
"content": ...,
}
# KnowledgeBaseRetrievalResultTypeDef definition
class KnowledgeBaseRetrievalResultTypeDef(TypedDict):
content: RetrievalResultContentTypeDef, # (1)
location: NotRequired[RetrievalResultLocationTypeDef], # (2)
metadata: NotRequired[Dict[str, Dict[str, Any]]],
score: NotRequired[float],RetrievedReferenceTypeDef#
# RetrievedReferenceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrievedReferenceTypeDef
def get_value() -> RetrievedReferenceTypeDef:
return {
"content": ...,
}
# RetrievedReferenceTypeDef definition
class RetrievedReferenceTypeDef(TypedDict):
content: NotRequired[RetrievalResultContentTypeDef], # (1)
location: NotRequired[RetrievalResultLocationTypeDef], # (2)
metadata: NotRequired[Dict[str, Dict[str, Any]]],GeneratedResponsePartTypeDef#
# GeneratedResponsePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GeneratedResponsePartTypeDef
def get_value() -> GeneratedResponsePartTypeDef:
return {
"textResponsePart": ...,
}
# GeneratedResponsePartTypeDef definition
class GeneratedResponsePartTypeDef(TypedDict):
textResponsePart: NotRequired[TextResponsePartTypeDef], # (1)TransformationConfigurationTypeDef#
# TransformationConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TransformationConfigurationTypeDef
def get_value() -> TransformationConfigurationTypeDef:
return {
"mode": ...,
}
# TransformationConfigurationTypeDef definition
class TransformationConfigurationTypeDef(TypedDict):
mode: QueryTransformationModeType, # (1)
textToSqlConfiguration: NotRequired[TextToSqlConfigurationTypeDef], # (2)ApiInvocationInputTypeDef#
# ApiInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiInvocationInputTypeDef
def get_value() -> ApiInvocationInputTypeDef:
return {
"actionGroup": ...,
}
# ApiInvocationInputTypeDef definition
class ApiInvocationInputTypeDef(TypedDict):
actionGroup: str,
actionInvocationType: NotRequired[ActionInvocationTypeType], # (1)
agentId: NotRequired[str],
apiPath: NotRequired[str],
collaboratorName: NotRequired[str],
httpMethod: NotRequired[str],
parameters: NotRequired[List[ApiParameterTypeDef]], # (2)
requestBody: NotRequired[ApiRequestBodyTypeDef], # (3)- See ActionInvocationTypeType
- See
List[ApiParameterTypeDef] - See ApiRequestBodyTypeDef
InputFileTypeDef#
# InputFileTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InputFileTypeDef
def get_value() -> InputFileTypeDef:
return {
"name": ...,
}
# InputFileTypeDef definition
class InputFileTypeDef(TypedDict):
name: str,
source: FileSourceTypeDef, # (1)
useCase: FileUseCaseType, # (2)- See FileSourceTypeDef
- See FileUseCaseType
ImageInputTypeDef#
# ImageInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ImageInputTypeDef
def get_value() -> ImageInputTypeDef:
return {
"format": ...,
}
# ImageInputTypeDef definition
class ImageInputTypeDef(TypedDict):
format: ImageInputFormatType, # (1)
source: ImageInputSourceUnionTypeDef, # (2)VectorSearchBedrockRerankingConfigurationTypeDef#
# VectorSearchBedrockRerankingConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import VectorSearchBedrockRerankingConfigurationTypeDef
def get_value() -> VectorSearchBedrockRerankingConfigurationTypeDef:
return {
"metadataConfiguration": ...,
}
# VectorSearchBedrockRerankingConfigurationTypeDef definition
class VectorSearchBedrockRerankingConfigurationTypeDef(TypedDict):
modelConfiguration: VectorSearchBedrockRerankingModelConfigurationTypeDef, # (2)
metadataConfiguration: NotRequired[MetadataConfigurationForRerankingTypeDef], # (1)
numberOfRerankedResults: NotRequired[int],- See MetadataConfigurationForRerankingTypeDef
- See VectorSearchBedrockRerankingModelConfigurationTypeDef
FlowTraceTypeDef#
# FlowTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceTypeDef
def get_value() -> FlowTraceTypeDef:
return {
"conditionNodeResultTrace": ...,
}
# FlowTraceTypeDef definition
class FlowTraceTypeDef(TypedDict):
conditionNodeResultTrace: NotRequired[FlowTraceConditionNodeResultEventTypeDef], # (1)
nodeActionTrace: NotRequired[FlowTraceNodeActionEventTypeDef], # (2)
nodeInputTrace: NotRequired[FlowTraceNodeInputEventTypeDef], # (3)
nodeOutputTrace: NotRequired[FlowTraceNodeOutputEventTypeDef], # (4)- See FlowTraceConditionNodeResultEventTypeDef
- See FlowTraceNodeActionEventTypeDef
- See FlowTraceNodeInputEventTypeDef
- See FlowTraceNodeOutputEventTypeDef
AgentActionGroupTypeDef#
# AgentActionGroupTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AgentActionGroupTypeDef
def get_value() -> AgentActionGroupTypeDef:
return {
"actionGroupExecutor": ...,
}
# AgentActionGroupTypeDef definition
class AgentActionGroupTypeDef(TypedDict):
actionGroupName: str,
actionGroupExecutor: NotRequired[ActionGroupExecutorTypeDef], # (1)
apiSchema: NotRequired[APISchemaTypeDef], # (2)
description: NotRequired[str],
functionSchema: NotRequired[FunctionSchemaTypeDef], # (3)
parentActionGroupSignature: NotRequired[ActionGroupSignatureType], # (4)
parentActionGroupSignatureParams: NotRequired[Mapping[str, str]],- See ActionGroupExecutorTypeDef
- See APISchemaTypeDef
- See FunctionSchemaTypeDef
- See ActionGroupSignatureType
GuardrailTraceTypeDef#
# GuardrailTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GuardrailTraceTypeDef
def get_value() -> GuardrailTraceTypeDef:
return {
"action": ...,
}
# GuardrailTraceTypeDef definition
class GuardrailTraceTypeDef(TypedDict):
action: NotRequired[GuardrailActionType], # (1)
inputAssessments: NotRequired[List[GuardrailAssessmentTypeDef]], # (2)
outputAssessments: NotRequired[List[GuardrailAssessmentTypeDef]], # (2)
traceId: NotRequired[str],- See GuardrailActionType
- See
List[GuardrailAssessmentTypeDef] - See
List[GuardrailAssessmentTypeDef]
ApiResultOutputTypeDef#
# ApiResultOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiResultOutputTypeDef
def get_value() -> ApiResultOutputTypeDef:
return {
"actionGroup": ...,
}
# ApiResultOutputTypeDef definition
class ApiResultOutputTypeDef(TypedDict):
actionGroup: str,
agentId: NotRequired[str],
apiPath: NotRequired[str],
confirmationState: NotRequired[ConfirmationStateType], # (1)
httpMethod: NotRequired[str],
httpStatusCode: NotRequired[int],
responseBody: NotRequired[Dict[str, ContentBodyOutputTypeDef]], # (2)
responseState: NotRequired[ResponseStateType], # (3)- See ConfirmationStateType
- See
Dict[str, ContentBodyOutputTypeDef] - See ResponseStateType
FunctionResultOutputTypeDef#
# FunctionResultOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionResultOutputTypeDef
def get_value() -> FunctionResultOutputTypeDef:
return {
"actionGroup": ...,
}
# FunctionResultOutputTypeDef definition
class FunctionResultOutputTypeDef(TypedDict):
actionGroup: str,
agentId: NotRequired[str],
confirmationState: NotRequired[ConfirmationStateType], # (1)
function: NotRequired[str],
responseBody: NotRequired[Dict[str, ContentBodyOutputTypeDef]], # (2)
responseState: NotRequired[ResponseStateType], # (3)- See ConfirmationStateType
- See
Dict[str, ContentBodyOutputTypeDef] - See ResponseStateType
BedrockSessionContentBlockOutputTypeDef#
# BedrockSessionContentBlockOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BedrockSessionContentBlockOutputTypeDef
def get_value() -> BedrockSessionContentBlockOutputTypeDef:
return {
"image": ...,
}
# BedrockSessionContentBlockOutputTypeDef definition
class BedrockSessionContentBlockOutputTypeDef(TypedDict):
image: NotRequired[ImageBlockOutputTypeDef], # (1)
text: NotRequired[str],BedrockSessionContentBlockTypeDef#
# BedrockSessionContentBlockTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import BedrockSessionContentBlockTypeDef
def get_value() -> BedrockSessionContentBlockTypeDef:
return {
"image": ...,
}
# BedrockSessionContentBlockTypeDef definition
class BedrockSessionContentBlockTypeDef(TypedDict):
image: NotRequired[ImageBlockTypeDef], # (1)
text: NotRequired[str],ExternalSourcesRetrieveAndGenerateConfigurationTypeDef#
# ExternalSourcesRetrieveAndGenerateConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
def get_value() -> ExternalSourcesRetrieveAndGenerateConfigurationTypeDef:
return {
"generationConfiguration": ...,
}
# ExternalSourcesRetrieveAndGenerateConfigurationTypeDef definition
class ExternalSourcesRetrieveAndGenerateConfigurationTypeDef(TypedDict):
modelArn: str,
sources: Sequence[ExternalSourceTypeDef], # (2)
generationConfiguration: NotRequired[ExternalSourcesGenerationConfigurationTypeDef], # (1)- See ExternalSourcesGenerationConfigurationTypeDef
- See
Sequence[ExternalSourceTypeDef]
PromptOverrideConfigurationTypeDef#
# PromptOverrideConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PromptOverrideConfigurationTypeDef
def get_value() -> PromptOverrideConfigurationTypeDef:
return {
"overrideLambda": ...,
}
# PromptOverrideConfigurationTypeDef definition
class PromptOverrideConfigurationTypeDef(TypedDict):
promptConfigurations: Sequence[PromptConfigurationTypeDef], # (1)
overrideLambda: NotRequired[str],- See
Sequence[PromptConfigurationTypeDef]
OptimizedPromptStreamTypeDef#
# OptimizedPromptStreamTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OptimizedPromptStreamTypeDef
def get_value() -> OptimizedPromptStreamTypeDef:
return {
"accessDeniedException": ...,
}
# OptimizedPromptStreamTypeDef definition
class OptimizedPromptStreamTypeDef(TypedDict):
accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef], # (1)
analyzePromptEvent: NotRequired[AnalyzePromptEventTypeDef], # (2)
badGatewayException: NotRequired[BadGatewayExceptionTypeDef], # (3)
dependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef], # (4)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (5)
optimizedPromptEvent: NotRequired[OptimizedPromptEventTypeDef], # (6)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (7)
validationException: NotRequired[ValidationExceptionTypeDef], # (8)- See AccessDeniedExceptionTypeDef
- See AnalyzePromptEventTypeDef
- See BadGatewayExceptionTypeDef
- See DependencyFailedExceptionTypeDef
- See InternalServerExceptionTypeDef
- See OptimizedPromptEventTypeDef
- See ThrottlingExceptionTypeDef
- See ValidationExceptionTypeDef
PostProcessingTraceTypeDef#
# PostProcessingTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PostProcessingTraceTypeDef
def get_value() -> PostProcessingTraceTypeDef:
return {
"modelInvocationInput": ...,
}
# PostProcessingTraceTypeDef definition
class PostProcessingTraceTypeDef(TypedDict):
modelInvocationInput: NotRequired[ModelInvocationInputTypeDef], # (1)
modelInvocationOutput: NotRequired[PostProcessingModelInvocationOutputTypeDef], # (2)PreProcessingTraceTypeDef#
# PreProcessingTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PreProcessingTraceTypeDef
def get_value() -> PreProcessingTraceTypeDef:
return {
"modelInvocationInput": ...,
}
# PreProcessingTraceTypeDef definition
class PreProcessingTraceTypeDef(TypedDict):
modelInvocationInput: NotRequired[ModelInvocationInputTypeDef], # (1)
modelInvocationOutput: NotRequired[PreProcessingModelInvocationOutputTypeDef], # (2)RerankResponseTypeDef#
# RerankResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankResponseTypeDef
def get_value() -> RerankResponseTypeDef:
return {
"nextToken": ...,
}
# RerankResponseTypeDef definition
class RerankResponseTypeDef(TypedDict):
results: List[RerankResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[RerankResultTypeDef] - See ResponseMetadataTypeDef
RerankSourceTypeDef#
# RerankSourceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankSourceTypeDef
def get_value() -> RerankSourceTypeDef:
return {
"inlineDocumentSource": ...,
}
# RerankSourceTypeDef definition
class RerankSourceTypeDef(TypedDict):
inlineDocumentSource: RerankDocumentUnionTypeDef, # (1)
type: RerankSourceTypeType, # (2)RetrieveResponseTypeDef#
# RetrieveResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveResponseTypeDef
def get_value() -> RetrieveResponseTypeDef:
return {
"guardrailAction": ...,
}
# RetrieveResponseTypeDef definition
class RetrieveResponseTypeDef(TypedDict):
guardrailAction: GuadrailActionType, # (1)
retrievalResults: List[KnowledgeBaseRetrievalResultTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
nextToken: NotRequired[str],- See GuadrailActionType
- See
List[KnowledgeBaseRetrievalResultTypeDef] - See ResponseMetadataTypeDef
KnowledgeBaseLookupOutputTypeDef#
# KnowledgeBaseLookupOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseLookupOutputTypeDef
def get_value() -> KnowledgeBaseLookupOutputTypeDef:
return {
"retrievedReferences": ...,
}
# KnowledgeBaseLookupOutputTypeDef definition
class KnowledgeBaseLookupOutputTypeDef(TypedDict):
retrievedReferences: NotRequired[List[RetrievedReferenceTypeDef]], # (1)- See
List[RetrievedReferenceTypeDef]
CitationTypeDef#
# CitationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CitationTypeDef
def get_value() -> CitationTypeDef:
return {
"generatedResponsePart": ...,
}
# CitationTypeDef definition
class CitationTypeDef(TypedDict):
generatedResponsePart: NotRequired[GeneratedResponsePartTypeDef], # (1)
retrievedReferences: NotRequired[List[RetrievedReferenceTypeDef]], # (2)- See GeneratedResponsePartTypeDef
- See
List[RetrievedReferenceTypeDef]
GenerateQueryRequestTypeDef#
# GenerateQueryRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GenerateQueryRequestTypeDef
def get_value() -> GenerateQueryRequestTypeDef:
return {
"queryGenerationInput": ...,
}
# GenerateQueryRequestTypeDef definition
class GenerateQueryRequestTypeDef(TypedDict):
queryGenerationInput: QueryGenerationInputTypeDef, # (1)
transformationConfiguration: TransformationConfigurationTypeDef, # (2)InvocationInputMemberTypeDef#
# InvocationInputMemberTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationInputMemberTypeDef
def get_value() -> InvocationInputMemberTypeDef:
return {
"apiInvocationInput": ...,
}
# InvocationInputMemberTypeDef definition
class InvocationInputMemberTypeDef(TypedDict):
apiInvocationInput: NotRequired[ApiInvocationInputTypeDef], # (1)
functionInvocationInput: NotRequired[FunctionInvocationInputTypeDef], # (2)VectorSearchRerankingConfigurationTypeDef#
# VectorSearchRerankingConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import VectorSearchRerankingConfigurationTypeDef
def get_value() -> VectorSearchRerankingConfigurationTypeDef:
return {
"bedrockRerankingConfiguration": ...,
}
# VectorSearchRerankingConfigurationTypeDef definition
class VectorSearchRerankingConfigurationTypeDef(TypedDict):
type: VectorSearchRerankingConfigurationTypeType, # (2)
bedrockRerankingConfiguration: NotRequired[VectorSearchBedrockRerankingConfigurationTypeDef], # (1)FlowTraceEventTypeDef#
# FlowTraceEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowTraceEventTypeDef
def get_value() -> FlowTraceEventTypeDef:
return {
"trace": ...,
}
# FlowTraceEventTypeDef definition
class FlowTraceEventTypeDef(TypedDict):
trace: FlowTraceTypeDef, # (1)- See FlowTraceTypeDef
InvocationResultMemberOutputTypeDef#
# InvocationResultMemberOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationResultMemberOutputTypeDef
def get_value() -> InvocationResultMemberOutputTypeDef:
return {
"apiResult": ...,
}
# InvocationResultMemberOutputTypeDef definition
class InvocationResultMemberOutputTypeDef(TypedDict):
apiResult: NotRequired[ApiResultOutputTypeDef], # (1)
functionResult: NotRequired[FunctionResultOutputTypeDef], # (2)InvocationStepPayloadOutputTypeDef#
# InvocationStepPayloadOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationStepPayloadOutputTypeDef
def get_value() -> InvocationStepPayloadOutputTypeDef:
return {
"contentBlocks": ...,
}
# InvocationStepPayloadOutputTypeDef definition
class InvocationStepPayloadOutputTypeDef(TypedDict):
contentBlocks: NotRequired[List[BedrockSessionContentBlockOutputTypeDef]], # (1)- See
List[BedrockSessionContentBlockOutputTypeDef]
InvocationStepPayloadTypeDef#
# InvocationStepPayloadTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationStepPayloadTypeDef
def get_value() -> InvocationStepPayloadTypeDef:
return {
"contentBlocks": ...,
}
# InvocationStepPayloadTypeDef definition
class InvocationStepPayloadTypeDef(TypedDict):
contentBlocks: NotRequired[Sequence[BedrockSessionContentBlockTypeDef]], # (1)- See
Sequence[BedrockSessionContentBlockTypeDef]
OptimizePromptResponseTypeDef#
# OptimizePromptResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OptimizePromptResponseTypeDef
def get_value() -> OptimizePromptResponseTypeDef:
return {
"optimizedPrompt": ...,
}
# OptimizePromptResponseTypeDef definition
class OptimizePromptResponseTypeDef(TypedDict):
optimizedPrompt: botocore.eventstream.EventStream[OptimizedPromptStreamTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
EventStream[OptimizedPromptStreamTypeDef] - See ResponseMetadataTypeDef
RerankRequestPaginateTypeDef#
# RerankRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankRequestPaginateTypeDef
def get_value() -> RerankRequestPaginateTypeDef:
return {
"queries": ...,
}
# RerankRequestPaginateTypeDef definition
class RerankRequestPaginateTypeDef(TypedDict):
queries: Sequence[RerankQueryTypeDef], # (1)
rerankingConfiguration: RerankingConfigurationTypeDef, # (2)
sources: Sequence[RerankSourceTypeDef], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See
Sequence[RerankQueryTypeDef] - See RerankingConfigurationTypeDef
- See
Sequence[RerankSourceTypeDef] - See PaginatorConfigTypeDef
RerankRequestTypeDef#
# RerankRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RerankRequestTypeDef
def get_value() -> RerankRequestTypeDef:
return {
"queries": ...,
}
# RerankRequestTypeDef definition
class RerankRequestTypeDef(TypedDict):
queries: Sequence[RerankQueryTypeDef], # (1)
rerankingConfiguration: RerankingConfigurationTypeDef, # (2)
sources: Sequence[RerankSourceTypeDef], # (3)
nextToken: NotRequired[str],- See
Sequence[RerankQueryTypeDef] - See RerankingConfigurationTypeDef
- See
Sequence[RerankSourceTypeDef]
AttributionTypeDef#
# AttributionTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AttributionTypeDef
def get_value() -> AttributionTypeDef:
return {
"citations": ...,
}
# AttributionTypeDef definition
class AttributionTypeDef(TypedDict):
citations: NotRequired[List[CitationTypeDef]], # (1)- See
List[CitationTypeDef]
CitationEventTypeDef#
# CitationEventTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CitationEventTypeDef
def get_value() -> CitationEventTypeDef:
return {
"citation": ...,
}
# CitationEventTypeDef definition
class CitationEventTypeDef(TypedDict):
citation: NotRequired[CitationTypeDef], # (1)
generatedResponsePart: NotRequired[GeneratedResponsePartTypeDef], # (2)
retrievedReferences: NotRequired[List[RetrievedReferenceTypeDef]], # (3)- See CitationTypeDef
- See GeneratedResponsePartTypeDef
- See
List[RetrievedReferenceTypeDef]
RetrieveAndGenerateResponseTypeDef#
# RetrieveAndGenerateResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateResponseTypeDef
def get_value() -> RetrieveAndGenerateResponseTypeDef:
return {
"citations": ...,
}
# RetrieveAndGenerateResponseTypeDef definition
class RetrieveAndGenerateResponseTypeDef(TypedDict):
citations: List[CitationTypeDef], # (1)
guardrailAction: GuadrailActionType, # (2)
output: RetrieveAndGenerateOutputTypeDef, # (3)
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See
List[CitationTypeDef] - See GuadrailActionType
- See RetrieveAndGenerateOutputTypeDef
- See ResponseMetadataTypeDef
InlineAgentReturnControlPayloadTypeDef#
# InlineAgentReturnControlPayloadTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineAgentReturnControlPayloadTypeDef
def get_value() -> InlineAgentReturnControlPayloadTypeDef:
return {
"invocationId": ...,
}
# InlineAgentReturnControlPayloadTypeDef definition
class InlineAgentReturnControlPayloadTypeDef(TypedDict):
invocationId: NotRequired[str],
invocationInputs: NotRequired[List[InvocationInputMemberTypeDef]], # (1)- See
List[InvocationInputMemberTypeDef]
ReturnControlPayloadTypeDef#
# ReturnControlPayloadTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ReturnControlPayloadTypeDef
def get_value() -> ReturnControlPayloadTypeDef:
return {
"invocationId": ...,
}
# ReturnControlPayloadTypeDef definition
class ReturnControlPayloadTypeDef(TypedDict):
invocationId: NotRequired[str],
invocationInputs: NotRequired[List[InvocationInputMemberTypeDef]], # (1)- See
List[InvocationInputMemberTypeDef]
ContentBodyTypeDef#
# ContentBodyTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ContentBodyTypeDef
def get_value() -> ContentBodyTypeDef:
return {
"body": ...,
}
# ContentBodyTypeDef definition
class ContentBodyTypeDef(TypedDict):
body: NotRequired[str],
images: NotRequired[Sequence[ImageInputUnionTypeDef]], # (1)- See
Sequence[ImageInputUnionTypeDef]
KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef#
# KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef
def get_value() -> KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef:
return {
"filter": ...,
}
# KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef definition
class KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef(TypedDict):
filter: NotRequired[RetrievalFilterPaginatorTypeDef], # (1)
implicitFilterConfiguration: NotRequired[ImplicitFilterConfigurationTypeDef], # (2)
numberOfResults: NotRequired[int],
overrideSearchType: NotRequired[SearchTypeType], # (3)
rerankingConfiguration: NotRequired[VectorSearchRerankingConfigurationTypeDef], # (4)- See RetrievalFilterPaginatorTypeDef
- See ImplicitFilterConfigurationTypeDef
- See SearchTypeType
- See VectorSearchRerankingConfigurationTypeDef
KnowledgeBaseVectorSearchConfigurationTypeDef#
# KnowledgeBaseVectorSearchConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseVectorSearchConfigurationTypeDef
def get_value() -> KnowledgeBaseVectorSearchConfigurationTypeDef:
return {
"filter": ...,
}
# KnowledgeBaseVectorSearchConfigurationTypeDef definition
class KnowledgeBaseVectorSearchConfigurationTypeDef(TypedDict):
filter: NotRequired[RetrievalFilterTypeDef], # (1)
implicitFilterConfiguration: NotRequired[ImplicitFilterConfigurationTypeDef], # (2)
numberOfResults: NotRequired[int],
overrideSearchType: NotRequired[SearchTypeType], # (3)
rerankingConfiguration: NotRequired[VectorSearchRerankingConfigurationTypeDef], # (4)- See RetrievalFilterTypeDef
- See ImplicitFilterConfigurationTypeDef
- See SearchTypeType
- See VectorSearchRerankingConfigurationTypeDef
FlowResponseStreamTypeDef#
# FlowResponseStreamTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FlowResponseStreamTypeDef
def get_value() -> FlowResponseStreamTypeDef:
return {
"accessDeniedException": ...,
}
# FlowResponseStreamTypeDef definition
class FlowResponseStreamTypeDef(TypedDict):
accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef], # (1)
badGatewayException: NotRequired[BadGatewayExceptionTypeDef], # (2)
conflictException: NotRequired[ConflictExceptionTypeDef], # (3)
dependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef], # (4)
flowCompletionEvent: NotRequired[FlowCompletionEventTypeDef], # (5)
flowMultiTurnInputRequestEvent: NotRequired[FlowMultiTurnInputRequestEventTypeDef], # (6)
flowOutputEvent: NotRequired[FlowOutputEventTypeDef], # (7)
flowTraceEvent: NotRequired[FlowTraceEventTypeDef], # (8)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (9)
resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef], # (10)
serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef], # (11)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (12)
validationException: NotRequired[ValidationExceptionTypeDef], # (13)- See AccessDeniedExceptionTypeDef
- See BadGatewayExceptionTypeDef
- See ConflictExceptionTypeDef
- See DependencyFailedExceptionTypeDef
- See FlowCompletionEventTypeDef
- See FlowMultiTurnInputRequestEventTypeDef
- See FlowOutputEventTypeDef
- See FlowTraceEventTypeDef
- See InternalServerExceptionTypeDef
- See ResourceNotFoundExceptionTypeDef
- See ServiceQuotaExceededExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See ValidationExceptionTypeDef
ReturnControlResultsTypeDef#
# ReturnControlResultsTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ReturnControlResultsTypeDef
def get_value() -> ReturnControlResultsTypeDef:
return {
"invocationId": ...,
}
# ReturnControlResultsTypeDef definition
class ReturnControlResultsTypeDef(TypedDict):
invocationId: NotRequired[str],
returnControlInvocationResults: NotRequired[List[InvocationResultMemberOutputTypeDef]], # (1)- See
List[InvocationResultMemberOutputTypeDef]
InvocationStepTypeDef#
# InvocationStepTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationStepTypeDef
def get_value() -> InvocationStepTypeDef:
return {
"invocationId": ...,
}
# InvocationStepTypeDef definition
class InvocationStepTypeDef(TypedDict):
invocationId: str,
invocationStepId: str,
invocationStepTime: datetime.datetime,
payload: InvocationStepPayloadOutputTypeDef, # (1)
sessionId: str,InlineAgentPayloadPartTypeDef#
# InlineAgentPayloadPartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineAgentPayloadPartTypeDef
def get_value() -> InlineAgentPayloadPartTypeDef:
return {
"attribution": ...,
}
# InlineAgentPayloadPartTypeDef definition
class InlineAgentPayloadPartTypeDef(TypedDict):
attribution: NotRequired[AttributionTypeDef], # (1)
bytes: NotRequired[bytes],PayloadPartTypeDef#
# PayloadPartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PayloadPartTypeDef
def get_value() -> PayloadPartTypeDef:
return {
"attribution": ...,
}
# PayloadPartTypeDef definition
class PayloadPartTypeDef(TypedDict):
attribution: NotRequired[AttributionTypeDef], # (1)
bytes: NotRequired[bytes],RetrieveAndGenerateStreamResponseOutputTypeDef#
# RetrieveAndGenerateStreamResponseOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateStreamResponseOutputTypeDef
def get_value() -> RetrieveAndGenerateStreamResponseOutputTypeDef:
return {
"accessDeniedException": ...,
}
# RetrieveAndGenerateStreamResponseOutputTypeDef definition
class RetrieveAndGenerateStreamResponseOutputTypeDef(TypedDict):
accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef], # (1)
badGatewayException: NotRequired[BadGatewayExceptionTypeDef], # (2)
citation: NotRequired[CitationEventTypeDef], # (3)
conflictException: NotRequired[ConflictExceptionTypeDef], # (4)
dependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef], # (5)
guardrail: NotRequired[GuardrailEventTypeDef], # (6)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (7)
output: NotRequired[RetrieveAndGenerateOutputEventTypeDef], # (8)
resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef], # (9)
serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef], # (10)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (11)
validationException: NotRequired[ValidationExceptionTypeDef], # (12)- See AccessDeniedExceptionTypeDef
- See BadGatewayExceptionTypeDef
- See CitationEventTypeDef
- See ConflictExceptionTypeDef
- See DependencyFailedExceptionTypeDef
- See GuardrailEventTypeDef
- See InternalServerExceptionTypeDef
- See RetrieveAndGenerateOutputEventTypeDef
- See ResourceNotFoundExceptionTypeDef
- See ServiceQuotaExceededExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See ValidationExceptionTypeDef
AgentCollaboratorOutputPayloadTypeDef#
# AgentCollaboratorOutputPayloadTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AgentCollaboratorOutputPayloadTypeDef
def get_value() -> AgentCollaboratorOutputPayloadTypeDef:
return {
"returnControlPayload": ...,
}
# AgentCollaboratorOutputPayloadTypeDef definition
class AgentCollaboratorOutputPayloadTypeDef(TypedDict):
returnControlPayload: NotRequired[ReturnControlPayloadTypeDef], # (1)
text: NotRequired[str],
type: NotRequired[PayloadTypeType], # (2)KnowledgeBaseRetrievalConfigurationPaginatorTypeDef#
# KnowledgeBaseRetrievalConfigurationPaginatorTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
def get_value() -> KnowledgeBaseRetrievalConfigurationPaginatorTypeDef:
return {
"vectorSearchConfiguration": ...,
}
# KnowledgeBaseRetrievalConfigurationPaginatorTypeDef definition
class KnowledgeBaseRetrievalConfigurationPaginatorTypeDef(TypedDict):
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef, # (1)KnowledgeBaseRetrievalConfigurationTypeDef#
# KnowledgeBaseRetrievalConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseRetrievalConfigurationTypeDef
def get_value() -> KnowledgeBaseRetrievalConfigurationTypeDef:
return {
"vectorSearchConfiguration": ...,
}
# KnowledgeBaseRetrievalConfigurationTypeDef definition
class KnowledgeBaseRetrievalConfigurationTypeDef(TypedDict):
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationTypeDef, # (1)InvokeFlowResponseTypeDef#
# InvokeFlowResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeFlowResponseTypeDef
def get_value() -> InvokeFlowResponseTypeDef:
return {
"executionId": ...,
}
# InvokeFlowResponseTypeDef definition
class InvokeFlowResponseTypeDef(TypedDict):
executionId: str,
responseStream: botocore.eventstream.EventStream[FlowResponseStreamTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
EventStream[FlowResponseStreamTypeDef] - See ResponseMetadataTypeDef
AgentCollaboratorInputPayloadTypeDef#
# AgentCollaboratorInputPayloadTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AgentCollaboratorInputPayloadTypeDef
def get_value() -> AgentCollaboratorInputPayloadTypeDef:
return {
"returnControlResults": ...,
}
# AgentCollaboratorInputPayloadTypeDef definition
class AgentCollaboratorInputPayloadTypeDef(TypedDict):
returnControlResults: NotRequired[ReturnControlResultsTypeDef], # (1)
text: NotRequired[str],
type: NotRequired[PayloadTypeType], # (2)GetInvocationStepResponseTypeDef#
# GetInvocationStepResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import GetInvocationStepResponseTypeDef
def get_value() -> GetInvocationStepResponseTypeDef:
return {
"invocationStep": ...,
}
# GetInvocationStepResponseTypeDef definition
class GetInvocationStepResponseTypeDef(TypedDict):
invocationStep: InvocationStepTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutInvocationStepRequestTypeDef#
# PutInvocationStepRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import PutInvocationStepRequestTypeDef
def get_value() -> PutInvocationStepRequestTypeDef:
return {
"invocationIdentifier": ...,
}
# PutInvocationStepRequestTypeDef definition
class PutInvocationStepRequestTypeDef(TypedDict):
invocationIdentifier: str,
invocationStepTime: TimestampTypeDef,
payload: InvocationStepPayloadUnionTypeDef, # (1)
sessionIdentifier: str,
invocationStepId: NotRequired[str],RetrieveAndGenerateStreamResponseTypeDef#
# RetrieveAndGenerateStreamResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateStreamResponseTypeDef
def get_value() -> RetrieveAndGenerateStreamResponseTypeDef:
return {
"sessionId": ...,
}
# RetrieveAndGenerateStreamResponseTypeDef definition
class RetrieveAndGenerateStreamResponseTypeDef(TypedDict):
sessionId: str,
stream: botocore.eventstream.EventStream[RetrieveAndGenerateStreamResponseOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
EventStream[RetrieveAndGenerateStreamResponseOutputTypeDef] - See ResponseMetadataTypeDef
AgentCollaboratorInvocationOutputTypeDef#
# AgentCollaboratorInvocationOutputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AgentCollaboratorInvocationOutputTypeDef
def get_value() -> AgentCollaboratorInvocationOutputTypeDef:
return {
"agentCollaboratorAliasArn": ...,
}
# AgentCollaboratorInvocationOutputTypeDef definition
class AgentCollaboratorInvocationOutputTypeDef(TypedDict):
agentCollaboratorAliasArn: NotRequired[str],
agentCollaboratorName: NotRequired[str],
output: NotRequired[AgentCollaboratorOutputPayloadTypeDef], # (1)ApiResultTypeDef#
# ApiResultTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ApiResultTypeDef
def get_value() -> ApiResultTypeDef:
return {
"actionGroup": ...,
}
# ApiResultTypeDef definition
class ApiResultTypeDef(TypedDict):
actionGroup: str,
agentId: NotRequired[str],
apiPath: NotRequired[str],
confirmationState: NotRequired[ConfirmationStateType], # (1)
httpMethod: NotRequired[str],
httpStatusCode: NotRequired[int],
responseBody: NotRequired[Mapping[str, ContentBodyUnionTypeDef]], # (2)
responseState: NotRequired[ResponseStateType], # (3)- See ConfirmationStateType
- See
Mapping[str, ContentBodyUnionTypeDef] - See ResponseStateType
FunctionResultTypeDef#
# FunctionResultTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import FunctionResultTypeDef
def get_value() -> FunctionResultTypeDef:
return {
"actionGroup": ...,
}
# FunctionResultTypeDef definition
class FunctionResultTypeDef(TypedDict):
actionGroup: str,
agentId: NotRequired[str],
confirmationState: NotRequired[ConfirmationStateType], # (1)
function: NotRequired[str],
responseBody: NotRequired[Mapping[str, ContentBodyUnionTypeDef]], # (2)
responseState: NotRequired[ResponseStateType], # (3)- See ConfirmationStateType
- See
Mapping[str, ContentBodyUnionTypeDef] - See ResponseStateType
RetrieveRequestPaginateTypeDef#
# RetrieveRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveRequestPaginateTypeDef
def get_value() -> RetrieveRequestPaginateTypeDef:
return {
"knowledgeBaseId": ...,
}
# RetrieveRequestPaginateTypeDef definition
class RetrieveRequestPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
retrievalQuery: KnowledgeBaseQueryTypeDef, # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationPaginatorTypeDef], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See KnowledgeBaseQueryTypeDef
- See GuardrailConfigurationTypeDef
- See KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
- See PaginatorConfigTypeDef
KnowledgeBaseConfigurationTypeDef#
# KnowledgeBaseConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseConfigurationTypeDef
def get_value() -> KnowledgeBaseConfigurationTypeDef:
return {
"knowledgeBaseId": ...,
}
# KnowledgeBaseConfigurationTypeDef definition
class KnowledgeBaseConfigurationTypeDef(TypedDict):
knowledgeBaseId: str,
retrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef, # (1)KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef#
# KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
def get_value() -> KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef:
return {
"generationConfiguration": ...,
}
# KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef definition
class KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef(TypedDict):
knowledgeBaseId: str,
modelArn: str,
generationConfiguration: NotRequired[GenerationConfigurationTypeDef], # (1)
orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef], # (2)
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef], # (3)- See GenerationConfigurationTypeDef
- See OrchestrationConfigurationTypeDef
- See KnowledgeBaseRetrievalConfigurationTypeDef
KnowledgeBaseTypeDef#
# KnowledgeBaseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import KnowledgeBaseTypeDef
def get_value() -> KnowledgeBaseTypeDef:
return {
"description": ...,
}
# KnowledgeBaseTypeDef definition
class KnowledgeBaseTypeDef(TypedDict):
description: str,
knowledgeBaseId: str,
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef], # (1)RetrieveRequestTypeDef#
# RetrieveRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveRequestTypeDef
def get_value() -> RetrieveRequestTypeDef:
return {
"knowledgeBaseId": ...,
}
# RetrieveRequestTypeDef definition
class RetrieveRequestTypeDef(TypedDict):
knowledgeBaseId: str,
retrievalQuery: KnowledgeBaseQueryTypeDef, # (1)
guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef], # (2)
nextToken: NotRequired[str],
retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef], # (3)- See KnowledgeBaseQueryTypeDef
- See GuardrailConfigurationTypeDef
- See KnowledgeBaseRetrievalConfigurationTypeDef
AgentCollaboratorInvocationInputTypeDef#
# AgentCollaboratorInvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import AgentCollaboratorInvocationInputTypeDef
def get_value() -> AgentCollaboratorInvocationInputTypeDef:
return {
"agentCollaboratorAliasArn": ...,
}
# AgentCollaboratorInvocationInputTypeDef definition
class AgentCollaboratorInvocationInputTypeDef(TypedDict):
agentCollaboratorAliasArn: NotRequired[str],
agentCollaboratorName: NotRequired[str],
input: NotRequired[AgentCollaboratorInputPayloadTypeDef], # (1)ObservationTypeDef#
# ObservationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ObservationTypeDef
def get_value() -> ObservationTypeDef:
return {
"actionGroupInvocationOutput": ...,
}
# ObservationTypeDef definition
class ObservationTypeDef(TypedDict):
actionGroupInvocationOutput: NotRequired[ActionGroupInvocationOutputTypeDef], # (1)
agentCollaboratorInvocationOutput: NotRequired[AgentCollaboratorInvocationOutputTypeDef], # (2)
codeInterpreterInvocationOutput: NotRequired[CodeInterpreterInvocationOutputTypeDef], # (3)
finalResponse: NotRequired[FinalResponseTypeDef], # (4)
knowledgeBaseLookupOutput: NotRequired[KnowledgeBaseLookupOutputTypeDef], # (5)
repromptResponse: NotRequired[RepromptResponseTypeDef], # (6)
traceId: NotRequired[str],
type: NotRequired[TypeType], # (7)- See ActionGroupInvocationOutputTypeDef
- See AgentCollaboratorInvocationOutputTypeDef
- See CodeInterpreterInvocationOutputTypeDef
- See FinalResponseTypeDef
- See KnowledgeBaseLookupOutputTypeDef
- See RepromptResponseTypeDef
- See TypeType
RetrieveAndGenerateConfigurationTypeDef#
# RetrieveAndGenerateConfigurationTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateConfigurationTypeDef
def get_value() -> RetrieveAndGenerateConfigurationTypeDef:
return {
"externalSourcesConfiguration": ...,
}
# RetrieveAndGenerateConfigurationTypeDef definition
class RetrieveAndGenerateConfigurationTypeDef(TypedDict):
type: RetrieveAndGenerateTypeType, # (3)
externalSourcesConfiguration: NotRequired[ExternalSourcesRetrieveAndGenerateConfigurationTypeDef], # (1)
knowledgeBaseConfiguration: NotRequired[KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef], # (2)- See ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- See KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- See RetrieveAndGenerateTypeType
CollaboratorTypeDef#
# CollaboratorTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import CollaboratorTypeDef
def get_value() -> CollaboratorTypeDef:
return {
"actionGroups": ...,
}
# CollaboratorTypeDef definition
class CollaboratorTypeDef(TypedDict):
foundationModel: str,
instruction: str,
actionGroups: NotRequired[Sequence[AgentActionGroupTypeDef]], # (1)
agentCollaboration: NotRequired[AgentCollaborationType], # (2)
agentName: NotRequired[str],
collaboratorConfigurations: NotRequired[Sequence[CollaboratorConfigurationTypeDef]], # (3)
customerEncryptionKeyArn: NotRequired[str],
guardrailConfiguration: NotRequired[GuardrailConfigurationWithArnTypeDef], # (4)
idleSessionTTLInSeconds: NotRequired[int],
knowledgeBases: NotRequired[Sequence[KnowledgeBaseTypeDef]], # (5)
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (6)- See
Sequence[AgentActionGroupTypeDef] - See AgentCollaborationType
- See
Sequence[CollaboratorConfigurationTypeDef] - See GuardrailConfigurationWithArnTypeDef
- See
Sequence[KnowledgeBaseTypeDef] - See PromptOverrideConfigurationTypeDef
InvocationInputTypeDef#
# InvocationInputTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationInputTypeDef
def get_value() -> InvocationInputTypeDef:
return {
"actionGroupInvocationInput": ...,
}
# InvocationInputTypeDef definition
class InvocationInputTypeDef(TypedDict):
actionGroupInvocationInput: NotRequired[ActionGroupInvocationInputTypeDef], # (1)
agentCollaboratorInvocationInput: NotRequired[AgentCollaboratorInvocationInputTypeDef], # (2)
codeInterpreterInvocationInput: NotRequired[CodeInterpreterInvocationInputTypeDef], # (3)
invocationType: NotRequired[InvocationTypeType], # (4)
knowledgeBaseLookupInput: NotRequired[KnowledgeBaseLookupInputTypeDef], # (5)
traceId: NotRequired[str],- See ActionGroupInvocationInputTypeDef
- See AgentCollaboratorInvocationInputTypeDef
- See CodeInterpreterInvocationInputTypeDef
- See InvocationTypeType
- See KnowledgeBaseLookupInputTypeDef
InvocationResultMemberTypeDef#
# InvocationResultMemberTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvocationResultMemberTypeDef
def get_value() -> InvocationResultMemberTypeDef:
return {
"apiResult": ...,
}
# InvocationResultMemberTypeDef definition
class InvocationResultMemberTypeDef(TypedDict):
apiResult: NotRequired[ApiResultUnionTypeDef], # (1)
functionResult: NotRequired[FunctionResultUnionTypeDef], # (2)RetrieveAndGenerateRequestTypeDef#
# RetrieveAndGenerateRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateRequestTypeDef
def get_value() -> RetrieveAndGenerateRequestTypeDef:
return {
"input": ...,
}
# RetrieveAndGenerateRequestTypeDef definition
class RetrieveAndGenerateRequestTypeDef(TypedDict):
input: RetrieveAndGenerateInputTypeDef, # (1)
retrieveAndGenerateConfiguration: NotRequired[RetrieveAndGenerateConfigurationTypeDef], # (2)
sessionConfiguration: NotRequired[RetrieveAndGenerateSessionConfigurationTypeDef], # (3)
sessionId: NotRequired[str],- See RetrieveAndGenerateInputTypeDef
- See RetrieveAndGenerateConfigurationTypeDef
- See RetrieveAndGenerateSessionConfigurationTypeDef
RetrieveAndGenerateStreamRequestTypeDef#
# RetrieveAndGenerateStreamRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RetrieveAndGenerateStreamRequestTypeDef
def get_value() -> RetrieveAndGenerateStreamRequestTypeDef:
return {
"input": ...,
}
# RetrieveAndGenerateStreamRequestTypeDef definition
class RetrieveAndGenerateStreamRequestTypeDef(TypedDict):
input: RetrieveAndGenerateInputTypeDef, # (1)
retrieveAndGenerateConfiguration: NotRequired[RetrieveAndGenerateConfigurationTypeDef], # (2)
sessionConfiguration: NotRequired[RetrieveAndGenerateSessionConfigurationTypeDef], # (3)
sessionId: NotRequired[str],- See RetrieveAndGenerateInputTypeDef
- See RetrieveAndGenerateConfigurationTypeDef
- See RetrieveAndGenerateSessionConfigurationTypeDef
OrchestrationTraceTypeDef#
# OrchestrationTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import OrchestrationTraceTypeDef
def get_value() -> OrchestrationTraceTypeDef:
return {
"invocationInput": ...,
}
# OrchestrationTraceTypeDef definition
class OrchestrationTraceTypeDef(TypedDict):
invocationInput: NotRequired[InvocationInputTypeDef], # (1)
modelInvocationInput: NotRequired[ModelInvocationInputTypeDef], # (2)
modelInvocationOutput: NotRequired[OrchestrationModelInvocationOutputTypeDef], # (3)
observation: NotRequired[ObservationTypeDef], # (4)
rationale: NotRequired[RationaleTypeDef], # (5)- See InvocationInputTypeDef
- See ModelInvocationInputTypeDef
- See OrchestrationModelInvocationOutputTypeDef
- See ObservationTypeDef
- See RationaleTypeDef
RoutingClassifierTraceTypeDef#
# RoutingClassifierTraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import RoutingClassifierTraceTypeDef
def get_value() -> RoutingClassifierTraceTypeDef:
return {
"invocationInput": ...,
}
# RoutingClassifierTraceTypeDef definition
class RoutingClassifierTraceTypeDef(TypedDict):
invocationInput: NotRequired[InvocationInputTypeDef], # (1)
modelInvocationInput: NotRequired[ModelInvocationInputTypeDef], # (2)
modelInvocationOutput: NotRequired[RoutingClassifierModelInvocationOutputTypeDef], # (3)
observation: NotRequired[ObservationTypeDef], # (4)- See InvocationInputTypeDef
- See ModelInvocationInputTypeDef
- See RoutingClassifierModelInvocationOutputTypeDef
- See ObservationTypeDef
TraceTypeDef#
# TraceTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TraceTypeDef
def get_value() -> TraceTypeDef:
return {
"customOrchestrationTrace": ...,
}
# TraceTypeDef definition
class TraceTypeDef(TypedDict):
customOrchestrationTrace: NotRequired[CustomOrchestrationTraceTypeDef], # (1)
failureTrace: NotRequired[FailureTraceTypeDef], # (2)
guardrailTrace: NotRequired[GuardrailTraceTypeDef], # (3)
orchestrationTrace: NotRequired[OrchestrationTraceTypeDef], # (4)
postProcessingTrace: NotRequired[PostProcessingTraceTypeDef], # (5)
preProcessingTrace: NotRequired[PreProcessingTraceTypeDef], # (6)
routingClassifierTrace: NotRequired[RoutingClassifierTraceTypeDef], # (7)- See CustomOrchestrationTraceTypeDef
- See FailureTraceTypeDef
- See GuardrailTraceTypeDef
- See OrchestrationTraceTypeDef
- See PostProcessingTraceTypeDef
- See PreProcessingTraceTypeDef
- See RoutingClassifierTraceTypeDef
InlineSessionStateTypeDef#
# InlineSessionStateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineSessionStateTypeDef
def get_value() -> InlineSessionStateTypeDef:
return {
"conversationHistory": ...,
}
# InlineSessionStateTypeDef definition
class InlineSessionStateTypeDef(TypedDict):
conversationHistory: NotRequired[ConversationHistoryTypeDef], # (1)
files: NotRequired[Sequence[InputFileTypeDef]], # (2)
invocationId: NotRequired[str],
promptSessionAttributes: NotRequired[Mapping[str, str]],
returnControlInvocationResults: NotRequired[Sequence[InvocationResultMemberUnionTypeDef]], # (3)
sessionAttributes: NotRequired[Mapping[str, str]],- See ConversationHistoryTypeDef
- See
Sequence[InputFileTypeDef] - See
Sequence[InvocationResultMemberUnionTypeDef]
SessionStateTypeDef#
# SessionStateTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import SessionStateTypeDef
def get_value() -> SessionStateTypeDef:
return {
"conversationHistory": ...,
}
# SessionStateTypeDef definition
class SessionStateTypeDef(TypedDict):
conversationHistory: NotRequired[ConversationHistoryTypeDef], # (1)
files: NotRequired[Sequence[InputFileTypeDef]], # (2)
invocationId: NotRequired[str],
knowledgeBaseConfigurations: NotRequired[Sequence[KnowledgeBaseConfigurationTypeDef]], # (3)
promptSessionAttributes: NotRequired[Mapping[str, str]],
returnControlInvocationResults: NotRequired[Sequence[InvocationResultMemberUnionTypeDef]], # (4)
sessionAttributes: NotRequired[Mapping[str, str]],- See ConversationHistoryTypeDef
- See
Sequence[InputFileTypeDef] - See
Sequence[KnowledgeBaseConfigurationTypeDef] - See
Sequence[InvocationResultMemberUnionTypeDef]
InlineAgentTracePartTypeDef#
# InlineAgentTracePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineAgentTracePartTypeDef
def get_value() -> InlineAgentTracePartTypeDef:
return {
"sessionId": ...,
}
# InlineAgentTracePartTypeDef definition
class InlineAgentTracePartTypeDef(TypedDict):
sessionId: NotRequired[str],
trace: NotRequired[TraceTypeDef], # (1)- See TraceTypeDef
TracePartTypeDef#
# TracePartTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import TracePartTypeDef
def get_value() -> TracePartTypeDef:
return {
"agentAliasId": ...,
}
# TracePartTypeDef definition
class TracePartTypeDef(TypedDict):
agentAliasId: NotRequired[str],
agentId: NotRequired[str],
agentVersion: NotRequired[str],
callerChain: NotRequired[List[CallerTypeDef]], # (1)
collaboratorName: NotRequired[str],
eventTime: NotRequired[datetime.datetime],
sessionId: NotRequired[str],
trace: NotRequired[TraceTypeDef], # (2)- See
List[CallerTypeDef] - See TraceTypeDef
InvokeInlineAgentRequestTypeDef#
# InvokeInlineAgentRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeInlineAgentRequestTypeDef
def get_value() -> InvokeInlineAgentRequestTypeDef:
return {
"foundationModel": ...,
}
# InvokeInlineAgentRequestTypeDef definition
class InvokeInlineAgentRequestTypeDef(TypedDict):
foundationModel: str,
instruction: str,
sessionId: str,
actionGroups: NotRequired[Sequence[AgentActionGroupTypeDef]], # (1)
agentCollaboration: NotRequired[AgentCollaborationType], # (2)
bedrockModelConfigurations: NotRequired[InlineBedrockModelConfigurationsTypeDef], # (3)
collaboratorConfigurations: NotRequired[Sequence[CollaboratorConfigurationTypeDef]], # (4)
collaborators: NotRequired[Sequence[CollaboratorTypeDef]], # (5)
customerEncryptionKeyArn: NotRequired[str],
enableTrace: NotRequired[bool],
endSession: NotRequired[bool],
guardrailConfiguration: NotRequired[GuardrailConfigurationWithArnTypeDef], # (6)
idleSessionTTLInSeconds: NotRequired[int],
inlineSessionState: NotRequired[InlineSessionStateTypeDef], # (7)
inputText: NotRequired[str],
knowledgeBases: NotRequired[Sequence[KnowledgeBaseTypeDef]], # (8)
promptOverrideConfiguration: NotRequired[PromptOverrideConfigurationTypeDef], # (9)
streamingConfigurations: NotRequired[StreamingConfigurationsTypeDef], # (10)- See
Sequence[AgentActionGroupTypeDef] - See AgentCollaborationType
- See InlineBedrockModelConfigurationsTypeDef
- See
Sequence[CollaboratorConfigurationTypeDef] - See
Sequence[CollaboratorTypeDef] - See GuardrailConfigurationWithArnTypeDef
- See InlineSessionStateTypeDef
- See
Sequence[KnowledgeBaseTypeDef] - See PromptOverrideConfigurationTypeDef
- See StreamingConfigurationsTypeDef
InvokeAgentRequestTypeDef#
# InvokeAgentRequestTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeAgentRequestTypeDef
def get_value() -> InvokeAgentRequestTypeDef:
return {
"agentAliasId": ...,
}
# InvokeAgentRequestTypeDef definition
class InvokeAgentRequestTypeDef(TypedDict):
agentAliasId: str,
agentId: str,
sessionId: str,
bedrockModelConfigurations: NotRequired[BedrockModelConfigurationsTypeDef], # (1)
enableTrace: NotRequired[bool],
endSession: NotRequired[bool],
inputText: NotRequired[str],
memoryId: NotRequired[str],
sessionState: NotRequired[SessionStateTypeDef], # (2)
sourceArn: NotRequired[str],
streamingConfigurations: NotRequired[StreamingConfigurationsTypeDef], # (3)InlineAgentResponseStreamTypeDef#
# InlineAgentResponseStreamTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InlineAgentResponseStreamTypeDef
def get_value() -> InlineAgentResponseStreamTypeDef:
return {
"accessDeniedException": ...,
}
# InlineAgentResponseStreamTypeDef definition
class InlineAgentResponseStreamTypeDef(TypedDict):
accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef], # (1)
badGatewayException: NotRequired[BadGatewayExceptionTypeDef], # (2)
chunk: NotRequired[InlineAgentPayloadPartTypeDef], # (3)
conflictException: NotRequired[ConflictExceptionTypeDef], # (4)
dependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef], # (5)
files: NotRequired[InlineAgentFilePartTypeDef], # (6)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (7)
resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef], # (8)
returnControl: NotRequired[InlineAgentReturnControlPayloadTypeDef], # (9)
serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef], # (10)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (11)
trace: NotRequired[InlineAgentTracePartTypeDef], # (12)
validationException: NotRequired[ValidationExceptionTypeDef], # (13)- See AccessDeniedExceptionTypeDef
- See BadGatewayExceptionTypeDef
- See InlineAgentPayloadPartTypeDef
- See ConflictExceptionTypeDef
- See DependencyFailedExceptionTypeDef
- See InlineAgentFilePartTypeDef
- See InternalServerExceptionTypeDef
- See ResourceNotFoundExceptionTypeDef
- See InlineAgentReturnControlPayloadTypeDef
- See ServiceQuotaExceededExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See InlineAgentTracePartTypeDef
- See ValidationExceptionTypeDef
ResponseStreamTypeDef#
# ResponseStreamTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import ResponseStreamTypeDef
def get_value() -> ResponseStreamTypeDef:
return {
"accessDeniedException": ...,
}
# ResponseStreamTypeDef definition
class ResponseStreamTypeDef(TypedDict):
accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef], # (1)
badGatewayException: NotRequired[BadGatewayExceptionTypeDef], # (2)
chunk: NotRequired[PayloadPartTypeDef], # (3)
conflictException: NotRequired[ConflictExceptionTypeDef], # (4)
dependencyFailedException: NotRequired[DependencyFailedExceptionTypeDef], # (5)
files: NotRequired[FilePartTypeDef], # (6)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (7)
modelNotReadyException: NotRequired[ModelNotReadyExceptionTypeDef], # (8)
resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef], # (9)
returnControl: NotRequired[ReturnControlPayloadTypeDef], # (10)
serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef], # (11)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (12)
trace: NotRequired[TracePartTypeDef], # (13)
validationException: NotRequired[ValidationExceptionTypeDef], # (14)- See AccessDeniedExceptionTypeDef
- See BadGatewayExceptionTypeDef
- See PayloadPartTypeDef
- See ConflictExceptionTypeDef
- See DependencyFailedExceptionTypeDef
- See FilePartTypeDef
- See InternalServerExceptionTypeDef
- See ModelNotReadyExceptionTypeDef
- See ResourceNotFoundExceptionTypeDef
- See ReturnControlPayloadTypeDef
- See ServiceQuotaExceededExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See TracePartTypeDef
- See ValidationExceptionTypeDef
InvokeInlineAgentResponseTypeDef#
# InvokeInlineAgentResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeInlineAgentResponseTypeDef
def get_value() -> InvokeInlineAgentResponseTypeDef:
return {
"completion": ...,
}
# InvokeInlineAgentResponseTypeDef definition
class InvokeInlineAgentResponseTypeDef(TypedDict):
completion: botocore.eventstream.EventStream[InlineAgentResponseStreamTypeDef], # (1)
contentType: str,
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
EventStream[InlineAgentResponseStreamTypeDef] - See ResponseMetadataTypeDef
InvokeAgentResponseTypeDef#
# InvokeAgentResponseTypeDef TypedDict usage example
from mypy_boto3_bedrock_agent_runtime.type_defs import InvokeAgentResponseTypeDef
def get_value() -> InvokeAgentResponseTypeDef:
return {
"completion": ...,
}
# InvokeAgentResponseTypeDef definition
class InvokeAgentResponseTypeDef(TypedDict):
completion: botocore.eventstream.EventStream[ResponseStreamTypeDef], # (1)
contentType: str,
memoryId: str,
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
EventStream[ResponseStreamTypeDef] - See ResponseMetadataTypeDef