Skip to content

Type definitions#

Index > AgentsforBedrockRuntime > Type definitions

Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AccessDeniedExceptionTypeDef#

# AccessDeniedExceptionTypeDef definition

class AccessDeniedExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ParameterTypeDef#

# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

ActionGroupInvocationOutputTypeDef#

# ActionGroupInvocationOutputTypeDef definition

class ActionGroupInvocationOutputTypeDef(TypedDict):
    text: NotRequired[str],

ApiParameterTypeDef#

# ApiParameterTypeDef definition

class ApiParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

ContentBodyTypeDef#

# ContentBodyTypeDef definition

class ContentBodyTypeDef(TypedDict):
    body: NotRequired[str],

BadGatewayExceptionTypeDef#

# BadGatewayExceptionTypeDef definition

class BadGatewayExceptionTypeDef(TypedDict):
    message: NotRequired[str],
    resourceName: NotRequired[str],

CodeInterpreterInvocationInputTypeDef#

# CodeInterpreterInvocationInputTypeDef definition

class CodeInterpreterInvocationInputTypeDef(TypedDict):
    code: NotRequired[str],
    files: NotRequired[List[str]],

CodeInterpreterInvocationOutputTypeDef#

# CodeInterpreterInvocationOutputTypeDef definition

class CodeInterpreterInvocationOutputTypeDef(TypedDict):
    executionError: NotRequired[str],
    executionOutput: NotRequired[str],
    executionTimeout: NotRequired[bool],
    files: NotRequired[List[str]],

ConflictExceptionTypeDef#

# ConflictExceptionTypeDef definition

class ConflictExceptionTypeDef(TypedDict):
    message: NotRequired[str],

DeleteAgentMemoryRequestRequestTypeDef#

# DeleteAgentMemoryRequestRequestTypeDef definition

class DeleteAgentMemoryRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,
    memoryId: NotRequired[str],

DependencyFailedExceptionTypeDef#

# DependencyFailedExceptionTypeDef definition

class DependencyFailedExceptionTypeDef(TypedDict):
    message: NotRequired[str],
    resourceName: NotRequired[str],

S3ObjectDocTypeDef#

# S3ObjectDocTypeDef definition

class S3ObjectDocTypeDef(TypedDict):
    uri: str,

GuardrailConfigurationTypeDef#

# GuardrailConfigurationTypeDef definition

class GuardrailConfigurationTypeDef(TypedDict):
    guardrailId: str,
    guardrailVersion: str,

PromptTemplateTypeDef#

# PromptTemplateTypeDef definition

class PromptTemplateTypeDef(TypedDict):
    textPromptTemplate: NotRequired[str],

FailureTraceTypeDef#

# FailureTraceTypeDef definition

class FailureTraceTypeDef(TypedDict):
    failureReason: NotRequired[str],
    traceId: NotRequired[str],

OutputFileTypeDef#

# OutputFileTypeDef definition

class OutputFileTypeDef(TypedDict):
    bytes: NotRequired[bytes],
    name: NotRequired[str],
    type: NotRequired[str],

S3ObjectFileTypeDef#

# S3ObjectFileTypeDef definition

class S3ObjectFileTypeDef(TypedDict):
    uri: str,

FilterAttributeTypeDef#

# FilterAttributeTypeDef definition

class FilterAttributeTypeDef(TypedDict):
    key: str,
    value: Mapping[str, Any],

FinalResponseTypeDef#

# FinalResponseTypeDef definition

class FinalResponseTypeDef(TypedDict):
    text: NotRequired[str],

FlowCompletionEventTypeDef#

# FlowCompletionEventTypeDef definition

class FlowCompletionEventTypeDef(TypedDict):
    completionReason: FlowCompletionReasonType,  # (1)
  1. See FlowCompletionReasonType

FlowInputContentTypeDef#

# FlowInputContentTypeDef definition

class FlowInputContentTypeDef(TypedDict):
    document: NotRequired[Mapping[str, Any]],

FlowOutputContentTypeDef#

# FlowOutputContentTypeDef definition

class FlowOutputContentTypeDef(TypedDict):
    document: NotRequired[Dict[str, Any]],

InternalServerExceptionTypeDef#

# InternalServerExceptionTypeDef definition

class InternalServerExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef definition

class ResourceNotFoundExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ServiceQuotaExceededExceptionTypeDef#

# ServiceQuotaExceededExceptionTypeDef definition

class ServiceQuotaExceededExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ThrottlingExceptionTypeDef#

# ThrottlingExceptionTypeDef definition

class ThrottlingExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ValidationExceptionTypeDef#

# ValidationExceptionTypeDef definition

class ValidationExceptionTypeDef(TypedDict):
    message: NotRequired[str],

FunctionParameterTypeDef#

# FunctionParameterTypeDef definition

class FunctionParameterTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetAgentMemoryRequestRequestTypeDef#

# GetAgentMemoryRequestRequestTypeDef definition

class GetAgentMemoryRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,
    memoryId: str,
    memoryType: MemoryTypeType,  # (1)
    maxItems: NotRequired[int],
    nextToken: NotRequired[str],
  1. See MemoryTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

GuardrailContentFilterTypeDef#

# GuardrailContentFilterTypeDef definition

class GuardrailContentFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailContentPolicyActionType],  # (1)
    confidence: NotRequired[GuardrailContentFilterConfidenceType],  # (2)
    type: NotRequired[GuardrailContentFilterTypeType],  # (3)
  1. See GuardrailContentPolicyActionType
  2. See GuardrailContentFilterConfidenceType
  3. See GuardrailContentFilterTypeType

GuardrailCustomWordTypeDef#

# GuardrailCustomWordTypeDef definition

class GuardrailCustomWordTypeDef(TypedDict):
    action: NotRequired[GuardrailWordPolicyActionType],  # (1)
    match: NotRequired[str],
  1. See GuardrailWordPolicyActionType

GuardrailManagedWordTypeDef#

# GuardrailManagedWordTypeDef definition

class GuardrailManagedWordTypeDef(TypedDict):
    action: NotRequired[GuardrailWordPolicyActionType],  # (1)
    match: NotRequired[str],
    type: NotRequired[GuardrailManagedWordTypeType],  # (2)
  1. See GuardrailWordPolicyActionType
  2. See GuardrailManagedWordTypeType

GuardrailPiiEntityFilterTypeDef#

# GuardrailPiiEntityFilterTypeDef definition

class GuardrailPiiEntityFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailSensitiveInformationPolicyActionType],  # (1)
    match: NotRequired[str],
    type: NotRequired[GuardrailPiiEntityTypeType],  # (2)
  1. See GuardrailSensitiveInformationPolicyActionType
  2. See GuardrailPiiEntityTypeType

GuardrailRegexFilterTypeDef#

# GuardrailRegexFilterTypeDef definition

class GuardrailRegexFilterTypeDef(TypedDict):
    action: NotRequired[GuardrailSensitiveInformationPolicyActionType],  # (1)
    match: NotRequired[str],
    name: NotRequired[str],
    regex: NotRequired[str],
  1. See GuardrailSensitiveInformationPolicyActionType

GuardrailTopicTypeDef#

# GuardrailTopicTypeDef definition

class GuardrailTopicTypeDef(TypedDict):
    action: NotRequired[GuardrailTopicPolicyActionType],  # (1)
    name: NotRequired[str],
    type: NotRequired[GuardrailTopicTypeType],  # (2)
  1. See GuardrailTopicPolicyActionType
  2. See GuardrailTopicTypeType

TextInferenceConfigTypeDef#

# TextInferenceConfigTypeDef definition

class TextInferenceConfigTypeDef(TypedDict):
    maxTokens: NotRequired[int],
    stopSequences: NotRequired[Sequence[str]],
    temperature: NotRequired[float],
    topP: NotRequired[float],

InferenceConfigurationTypeDef#

# InferenceConfigurationTypeDef definition

class InferenceConfigurationTypeDef(TypedDict):
    maximumLength: NotRequired[int],
    stopSequences: NotRequired[List[str]],
    temperature: NotRequired[float],
    topK: NotRequired[int],
    topP: NotRequired[float],

KnowledgeBaseLookupInputTypeDef#

# KnowledgeBaseLookupInputTypeDef definition

class KnowledgeBaseLookupInputTypeDef(TypedDict):
    knowledgeBaseId: NotRequired[str],
    text: NotRequired[str],

KnowledgeBaseQueryTypeDef#

# KnowledgeBaseQueryTypeDef definition

class KnowledgeBaseQueryTypeDef(TypedDict):
    text: str,

KnowledgeBaseVectorSearchConfigurationTypeDef#

# KnowledgeBaseVectorSearchConfigurationTypeDef definition

class KnowledgeBaseVectorSearchConfigurationTypeDef(TypedDict):
    filter: NotRequired[RetrievalFilterTypeDef],  # (1)
    numberOfResults: NotRequired[int],
    overrideSearchType: NotRequired[SearchTypeType],  # (2)
  1. See RetrievalFilterTypeDef
  2. See SearchTypeType

RetrievalResultContentTypeDef#

# RetrievalResultContentTypeDef definition

class RetrievalResultContentTypeDef(TypedDict):
    text: str,

MemorySessionSummaryTypeDef#

# MemorySessionSummaryTypeDef definition

class MemorySessionSummaryTypeDef(TypedDict):
    memoryId: NotRequired[str],
    sessionExpiryTime: NotRequired[datetime],
    sessionId: NotRequired[str],
    sessionStartTime: NotRequired[datetime],
    summaryText: NotRequired[str],

RepromptResponseTypeDef#

# RepromptResponseTypeDef definition

class RepromptResponseTypeDef(TypedDict):
    source: NotRequired[SourceType],  # (1)
    text: NotRequired[str],
  1. See SourceType

QueryTransformationConfigurationTypeDef#

# QueryTransformationConfigurationTypeDef definition

class QueryTransformationConfigurationTypeDef(TypedDict):
    type: QueryTransformationTypeType,  # (1)
  1. See QueryTransformationTypeType

RationaleTypeDef#

# RationaleTypeDef definition

class RationaleTypeDef(TypedDict):
    text: NotRequired[str],
    traceId: NotRequired[str],

PostProcessingParsedResponseTypeDef#

# PostProcessingParsedResponseTypeDef definition

class PostProcessingParsedResponseTypeDef(TypedDict):
    text: NotRequired[str],

PreProcessingParsedResponseTypeDef#

# PreProcessingParsedResponseTypeDef definition

class PreProcessingParsedResponseTypeDef(TypedDict):
    isValid: NotRequired[bool],
    rationale: NotRequired[str],

RetrievalResultConfluenceLocationTypeDef#

# RetrievalResultConfluenceLocationTypeDef definition

class RetrievalResultConfluenceLocationTypeDef(TypedDict):
    url: NotRequired[str],

RetrievalResultS3LocationTypeDef#

# RetrievalResultS3LocationTypeDef definition

class RetrievalResultS3LocationTypeDef(TypedDict):
    uri: NotRequired[str],

RetrievalResultSalesforceLocationTypeDef#

# RetrievalResultSalesforceLocationTypeDef definition

class RetrievalResultSalesforceLocationTypeDef(TypedDict):
    url: NotRequired[str],

RetrievalResultSharePointLocationTypeDef#

# RetrievalResultSharePointLocationTypeDef definition

class RetrievalResultSharePointLocationTypeDef(TypedDict):
    url: NotRequired[str],

RetrievalResultWebLocationTypeDef#

# RetrievalResultWebLocationTypeDef definition

class RetrievalResultWebLocationTypeDef(TypedDict):
    url: NotRequired[str],

RetrieveAndGenerateInputTypeDef#

# RetrieveAndGenerateInputTypeDef definition

class RetrieveAndGenerateInputTypeDef(TypedDict):
    text: str,

RetrieveAndGenerateOutputTypeDef#

# RetrieveAndGenerateOutputTypeDef definition

class RetrieveAndGenerateOutputTypeDef(TypedDict):
    text: str,

RetrieveAndGenerateSessionConfigurationTypeDef#

# RetrieveAndGenerateSessionConfigurationTypeDef definition

class RetrieveAndGenerateSessionConfigurationTypeDef(TypedDict):
    kmsKeyArn: str,

SpanTypeDef#

# SpanTypeDef definition

class SpanTypeDef(TypedDict):
    end: NotRequired[int],
    start: NotRequired[int],

PropertyParametersTypeDef#

# PropertyParametersTypeDef definition

class PropertyParametersTypeDef(TypedDict):
    properties: NotRequired[List[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

RequestBodyTypeDef#

# RequestBodyTypeDef definition

class RequestBodyTypeDef(TypedDict):
    content: NotRequired[Dict[str, List[ParameterTypeDef]]],  # (1)
  1. See ParameterTypeDef

ApiResultTypeDef#

# ApiResultTypeDef definition

class ApiResultTypeDef(TypedDict):
    actionGroup: str,
    apiPath: NotRequired[str],
    httpMethod: NotRequired[str],
    httpStatusCode: NotRequired[int],
    responseBody: NotRequired[Mapping[str, ContentBodyTypeDef]],  # (1)
    responseState: NotRequired[ResponseStateType],  # (2)
  1. See ContentBodyTypeDef
  2. See ResponseStateType

FunctionResultTypeDef#

# FunctionResultTypeDef definition

class FunctionResultTypeDef(TypedDict):
    actionGroup: str,
    function: NotRequired[str],
    responseBody: NotRequired[Mapping[str, ContentBodyTypeDef]],  # (1)
    responseState: NotRequired[ResponseStateType],  # (2)
  1. See ContentBodyTypeDef
  2. See ResponseStateType

ByteContentDocTypeDef#

# ByteContentDocTypeDef definition

class ByteContentDocTypeDef(TypedDict):
    contentType: str,
    data: Union[str, bytes, IO[Any], StreamingBody],
    identifier: str,

ByteContentFileTypeDef#

# ByteContentFileTypeDef definition

class ByteContentFileTypeDef(TypedDict):
    data: Union[str, bytes, IO[Any], StreamingBody],
    mediaType: str,

FilePartTypeDef#

# FilePartTypeDef definition

class FilePartTypeDef(TypedDict):
    files: NotRequired[List[OutputFileTypeDef]],  # (1)
  1. See OutputFileTypeDef

RetrievalFilterTypeDef#

# RetrievalFilterTypeDef definition

class RetrievalFilterTypeDef(TypedDict):
    andAll: NotRequired[Sequence[Dict[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[Dict[str, Any]]],
    startsWith: NotRequired[FilterAttributeTypeDef],  # (1)
    stringContains: NotRequired[FilterAttributeTypeDef],  # (1)
  1. See FilterAttributeTypeDef
  2. See FilterAttributeTypeDef
  3. See FilterAttributeTypeDef
  4. See FilterAttributeTypeDef
  5. See FilterAttributeTypeDef
  6. See FilterAttributeTypeDef
  7. See FilterAttributeTypeDef
  8. See FilterAttributeTypeDef
  9. See FilterAttributeTypeDef
  10. See FilterAttributeTypeDef
  11. See FilterAttributeTypeDef

FlowInputTypeDef#

# FlowInputTypeDef definition

class FlowInputTypeDef(TypedDict):
    content: FlowInputContentTypeDef,  # (1)
    nodeName: str,
    nodeOutputName: str,
  1. See FlowInputContentTypeDef

FlowOutputEventTypeDef#

# FlowOutputEventTypeDef definition

class FlowOutputEventTypeDef(TypedDict):
    content: FlowOutputContentTypeDef,  # (1)
    nodeName: str,
    nodeType: NodeTypeType,  # (2)
  1. See FlowOutputContentTypeDef
  2. See NodeTypeType

FunctionInvocationInputTypeDef#

# FunctionInvocationInputTypeDef definition

class FunctionInvocationInputTypeDef(TypedDict):
    actionGroup: str,
    function: NotRequired[str],
    parameters: NotRequired[List[FunctionParameterTypeDef]],  # (1)
  1. See FunctionParameterTypeDef

GetAgentMemoryRequestGetAgentMemoryPaginateTypeDef#

# GetAgentMemoryRequestGetAgentMemoryPaginateTypeDef definition

class GetAgentMemoryRequestGetAgentMemoryPaginateTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,
    memoryId: str,
    memoryType: MemoryTypeType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MemoryTypeType
  2. See PaginatorConfigTypeDef

GuardrailContentPolicyAssessmentTypeDef#

# GuardrailContentPolicyAssessmentTypeDef definition

class GuardrailContentPolicyAssessmentTypeDef(TypedDict):
    filters: NotRequired[List[GuardrailContentFilterTypeDef]],  # (1)
  1. See GuardrailContentFilterTypeDef

GuardrailWordPolicyAssessmentTypeDef#

# GuardrailWordPolicyAssessmentTypeDef definition

class GuardrailWordPolicyAssessmentTypeDef(TypedDict):
    customWords: NotRequired[List[GuardrailCustomWordTypeDef]],  # (1)
    managedWordLists: NotRequired[List[GuardrailManagedWordTypeDef]],  # (2)
  1. See GuardrailCustomWordTypeDef
  2. See GuardrailManagedWordTypeDef

GuardrailSensitiveInformationPolicyAssessmentTypeDef#

# GuardrailSensitiveInformationPolicyAssessmentTypeDef definition

class GuardrailSensitiveInformationPolicyAssessmentTypeDef(TypedDict):
    piiEntities: NotRequired[List[GuardrailPiiEntityFilterTypeDef]],  # (1)
    regexes: NotRequired[List[GuardrailRegexFilterTypeDef]],  # (2)
  1. See GuardrailPiiEntityFilterTypeDef
  2. See GuardrailRegexFilterTypeDef

GuardrailTopicPolicyAssessmentTypeDef#

# GuardrailTopicPolicyAssessmentTypeDef definition

class GuardrailTopicPolicyAssessmentTypeDef(TypedDict):
    topics: NotRequired[List[GuardrailTopicTypeDef]],  # (1)
  1. See GuardrailTopicTypeDef

InferenceConfigTypeDef#

# InferenceConfigTypeDef definition

class InferenceConfigTypeDef(TypedDict):
    textInferenceConfig: NotRequired[TextInferenceConfigTypeDef],  # (1)
  1. See TextInferenceConfigTypeDef

ModelInvocationInputTypeDef#

# ModelInvocationInputTypeDef definition

class ModelInvocationInputTypeDef(TypedDict):
    inferenceConfiguration: NotRequired[InferenceConfigurationTypeDef],  # (1)
    overrideLambda: NotRequired[str],
    parserMode: NotRequired[CreationModeType],  # (2)
    promptCreationMode: NotRequired[CreationModeType],  # (2)
    text: NotRequired[str],
    traceId: NotRequired[str],
    type: NotRequired[PromptTypeType],  # (4)
  1. See InferenceConfigurationTypeDef
  2. See CreationModeType
  3. See CreationModeType
  4. See PromptTypeType

KnowledgeBaseRetrievalConfigurationTypeDef#

# KnowledgeBaseRetrievalConfigurationTypeDef definition

class KnowledgeBaseRetrievalConfigurationTypeDef(TypedDict):
    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationTypeDef,  # (1)
  1. See KnowledgeBaseVectorSearchConfigurationTypeDef

MemoryTypeDef#

# MemoryTypeDef definition

class MemoryTypeDef(TypedDict):
    sessionSummary: NotRequired[MemorySessionSummaryTypeDef],  # (1)
  1. See MemorySessionSummaryTypeDef

OrchestrationConfigurationTypeDef#

# OrchestrationConfigurationTypeDef definition

class OrchestrationConfigurationTypeDef(TypedDict):
    queryTransformationConfiguration: QueryTransformationConfigurationTypeDef,  # (1)
  1. See QueryTransformationConfigurationTypeDef

PostProcessingModelInvocationOutputTypeDef#

# PostProcessingModelInvocationOutputTypeDef definition

class PostProcessingModelInvocationOutputTypeDef(TypedDict):
    parsedResponse: NotRequired[PostProcessingParsedResponseTypeDef],  # (1)
    traceId: NotRequired[str],
  1. See PostProcessingParsedResponseTypeDef

PreProcessingModelInvocationOutputTypeDef#

# PreProcessingModelInvocationOutputTypeDef definition

class PreProcessingModelInvocationOutputTypeDef(TypedDict):
    parsedResponse: NotRequired[PreProcessingParsedResponseTypeDef],  # (1)
    traceId: NotRequired[str],
  1. See PreProcessingParsedResponseTypeDef

RetrievalResultLocationTypeDef#

# RetrievalResultLocationTypeDef definition

class RetrievalResultLocationTypeDef(TypedDict):
    type: RetrievalResultLocationTypeType,  # (5)
    confluenceLocation: NotRequired[RetrievalResultConfluenceLocationTypeDef],  # (1)
    s3Location: NotRequired[RetrievalResultS3LocationTypeDef],  # (2)
    salesforceLocation: NotRequired[RetrievalResultSalesforceLocationTypeDef],  # (3)
    sharePointLocation: NotRequired[RetrievalResultSharePointLocationTypeDef],  # (4)
    webLocation: NotRequired[RetrievalResultWebLocationTypeDef],  # (6)
  1. See RetrievalResultConfluenceLocationTypeDef
  2. See RetrievalResultS3LocationTypeDef
  3. See RetrievalResultSalesforceLocationTypeDef
  4. See RetrievalResultSharePointLocationTypeDef
  5. See RetrievalResultLocationTypeType
  6. See RetrievalResultWebLocationTypeDef

TextResponsePartTypeDef#

# TextResponsePartTypeDef definition

class TextResponsePartTypeDef(TypedDict):
    span: NotRequired[SpanTypeDef],  # (1)
    text: NotRequired[str],
  1. See SpanTypeDef

ApiRequestBodyTypeDef#

# ApiRequestBodyTypeDef definition

class ApiRequestBodyTypeDef(TypedDict):
    content: NotRequired[Dict[str, PropertyParametersTypeDef]],  # (1)
  1. See PropertyParametersTypeDef

ActionGroupInvocationInputTypeDef#

# 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],
  1. See ExecutionTypeType
  2. See ParameterTypeDef
  3. See RequestBodyTypeDef

InvocationResultMemberTypeDef#

# InvocationResultMemberTypeDef definition

class InvocationResultMemberTypeDef(TypedDict):
    apiResult: NotRequired[ApiResultTypeDef],  # (1)
    functionResult: NotRequired[FunctionResultTypeDef],  # (2)
  1. See ApiResultTypeDef
  2. See FunctionResultTypeDef

ExternalSourceTypeDef#

# ExternalSourceTypeDef definition

class ExternalSourceTypeDef(TypedDict):
    sourceType: ExternalSourceTypeType,  # (3)
    byteContent: NotRequired[ByteContentDocTypeDef],  # (1)
    s3Location: NotRequired[S3ObjectDocTypeDef],  # (2)
  1. See ByteContentDocTypeDef
  2. See S3ObjectDocTypeDef
  3. See ExternalSourceTypeType

FileSourceTypeDef#

# FileSourceTypeDef definition

class FileSourceTypeDef(TypedDict):
    sourceType: FileSourceTypeType,  # (3)
    byteContent: NotRequired[ByteContentFileTypeDef],  # (1)
    s3Location: NotRequired[S3ObjectFileTypeDef],  # (2)
  1. See ByteContentFileTypeDef
  2. See S3ObjectFileTypeDef
  3. See FileSourceTypeType

InvokeFlowRequestRequestTypeDef#

# InvokeFlowRequestRequestTypeDef definition

class InvokeFlowRequestRequestTypeDef(TypedDict):
    flowAliasIdentifier: str,
    flowIdentifier: str,
    inputs: Sequence[FlowInputTypeDef],  # (1)
  1. See FlowInputTypeDef

FlowResponseStreamTypeDef#

# 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)
    flowOutputEvent: NotRequired[FlowOutputEventTypeDef],  # (6)
    internalServerException: NotRequired[InternalServerExceptionTypeDef],  # (7)
    resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef],  # (8)
    serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef],  # (9)
    throttlingException: NotRequired[ThrottlingExceptionTypeDef],  # (10)
    validationException: NotRequired[ValidationExceptionTypeDef],  # (11)
  1. See AccessDeniedExceptionTypeDef
  2. See BadGatewayExceptionTypeDef
  3. See ConflictExceptionTypeDef
  4. See DependencyFailedExceptionTypeDef
  5. See FlowCompletionEventTypeDef
  6. See FlowOutputEventTypeDef
  7. See InternalServerExceptionTypeDef
  8. See ResourceNotFoundExceptionTypeDef
  9. See ServiceQuotaExceededExceptionTypeDef
  10. See ThrottlingExceptionTypeDef
  11. See ValidationExceptionTypeDef

GuardrailAssessmentTypeDef#

# GuardrailAssessmentTypeDef definition

class GuardrailAssessmentTypeDef(TypedDict):
    contentPolicy: NotRequired[GuardrailContentPolicyAssessmentTypeDef],  # (1)
    sensitiveInformationPolicy: NotRequired[GuardrailSensitiveInformationPolicyAssessmentTypeDef],  # (2)
    topicPolicy: NotRequired[GuardrailTopicPolicyAssessmentTypeDef],  # (3)
    wordPolicy: NotRequired[GuardrailWordPolicyAssessmentTypeDef],  # (4)
  1. See GuardrailContentPolicyAssessmentTypeDef
  2. See GuardrailSensitiveInformationPolicyAssessmentTypeDef
  3. See GuardrailTopicPolicyAssessmentTypeDef
  4. See GuardrailWordPolicyAssessmentTypeDef

ExternalSourcesGenerationConfigurationTypeDef#

# ExternalSourcesGenerationConfigurationTypeDef definition

class ExternalSourcesGenerationConfigurationTypeDef(TypedDict):
    additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (1)
    inferenceConfig: NotRequired[InferenceConfigTypeDef],  # (2)
    promptTemplate: NotRequired[PromptTemplateTypeDef],  # (3)
  1. See GuardrailConfigurationTypeDef
  2. See InferenceConfigTypeDef
  3. See PromptTemplateTypeDef

GenerationConfigurationTypeDef#

# GenerationConfigurationTypeDef definition

class GenerationConfigurationTypeDef(TypedDict):
    additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]],
    guardrailConfiguration: NotRequired[GuardrailConfigurationTypeDef],  # (1)
    inferenceConfig: NotRequired[InferenceConfigTypeDef],  # (2)
    promptTemplate: NotRequired[PromptTemplateTypeDef],  # (3)
  1. See GuardrailConfigurationTypeDef
  2. See InferenceConfigTypeDef
  3. See PromptTemplateTypeDef

KnowledgeBaseConfigurationTypeDef#

# KnowledgeBaseConfigurationTypeDef definition

class KnowledgeBaseConfigurationTypeDef(TypedDict):
    knowledgeBaseId: str,
    retrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef,  # (1)
  1. See KnowledgeBaseRetrievalConfigurationTypeDef

RetrieveRequestRequestTypeDef#

# RetrieveRequestRequestTypeDef definition

class RetrieveRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    retrievalQuery: KnowledgeBaseQueryTypeDef,  # (1)
    nextToken: NotRequired[str],
    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef],  # (2)
  1. See KnowledgeBaseQueryTypeDef
  2. See KnowledgeBaseRetrievalConfigurationTypeDef

RetrieveRequestRetrievePaginateTypeDef#

# RetrieveRequestRetrievePaginateTypeDef definition

class RetrieveRequestRetrievePaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    retrievalQuery: KnowledgeBaseQueryTypeDef,  # (1)
    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See KnowledgeBaseQueryTypeDef
  2. See KnowledgeBaseRetrievalConfigurationTypeDef
  3. See PaginatorConfigTypeDef

GetAgentMemoryResponseTypeDef#

# GetAgentMemoryResponseTypeDef definition

class GetAgentMemoryResponseTypeDef(TypedDict):
    memoryContents: List[MemoryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MemoryTypeDef
  2. See ResponseMetadataTypeDef

PostProcessingTraceTypeDef#

# PostProcessingTraceTypeDef definition

class PostProcessingTraceTypeDef(TypedDict):
    modelInvocationInput: NotRequired[ModelInvocationInputTypeDef],  # (1)
    modelInvocationOutput: NotRequired[PostProcessingModelInvocationOutputTypeDef],  # (2)
  1. See ModelInvocationInputTypeDef
  2. See PostProcessingModelInvocationOutputTypeDef

PreProcessingTraceTypeDef#

# PreProcessingTraceTypeDef definition

class PreProcessingTraceTypeDef(TypedDict):
    modelInvocationInput: NotRequired[ModelInvocationInputTypeDef],  # (1)
    modelInvocationOutput: NotRequired[PreProcessingModelInvocationOutputTypeDef],  # (2)
  1. See ModelInvocationInputTypeDef
  2. See PreProcessingModelInvocationOutputTypeDef

KnowledgeBaseRetrievalResultTypeDef#

# KnowledgeBaseRetrievalResultTypeDef definition

class KnowledgeBaseRetrievalResultTypeDef(TypedDict):
    content: RetrievalResultContentTypeDef,  # (1)
    location: NotRequired[RetrievalResultLocationTypeDef],  # (2)
    metadata: NotRequired[Dict[str, Dict[str, Any]]],
    score: NotRequired[float],
  1. See RetrievalResultContentTypeDef
  2. See RetrievalResultLocationTypeDef

RetrievedReferenceTypeDef#

# RetrievedReferenceTypeDef definition

class RetrievedReferenceTypeDef(TypedDict):
    content: NotRequired[RetrievalResultContentTypeDef],  # (1)
    location: NotRequired[RetrievalResultLocationTypeDef],  # (2)
    metadata: NotRequired[Dict[str, Dict[str, Any]]],
  1. See RetrievalResultContentTypeDef
  2. See RetrievalResultLocationTypeDef

GeneratedResponsePartTypeDef#

# GeneratedResponsePartTypeDef definition

class GeneratedResponsePartTypeDef(TypedDict):
    textResponsePart: NotRequired[TextResponsePartTypeDef],  # (1)
  1. See TextResponsePartTypeDef

ApiInvocationInputTypeDef#

# ApiInvocationInputTypeDef definition

class ApiInvocationInputTypeDef(TypedDict):
    actionGroup: str,
    apiPath: NotRequired[str],
    httpMethod: NotRequired[str],
    parameters: NotRequired[List[ApiParameterTypeDef]],  # (1)
    requestBody: NotRequired[ApiRequestBodyTypeDef],  # (2)
  1. See ApiParameterTypeDef
  2. See ApiRequestBodyTypeDef

InvocationInputTypeDef#

# InvocationInputTypeDef definition

class InvocationInputTypeDef(TypedDict):
    actionGroupInvocationInput: NotRequired[ActionGroupInvocationInputTypeDef],  # (1)
    codeInterpreterInvocationInput: NotRequired[CodeInterpreterInvocationInputTypeDef],  # (2)
    invocationType: NotRequired[InvocationTypeType],  # (3)
    knowledgeBaseLookupInput: NotRequired[KnowledgeBaseLookupInputTypeDef],  # (4)
    traceId: NotRequired[str],
  1. See ActionGroupInvocationInputTypeDef
  2. See CodeInterpreterInvocationInputTypeDef
  3. See InvocationTypeType
  4. See KnowledgeBaseLookupInputTypeDef

InputFileTypeDef#

# InputFileTypeDef definition

class InputFileTypeDef(TypedDict):
    name: str,
    source: FileSourceTypeDef,  # (1)
    useCase: FileUseCaseType,  # (2)
  1. See FileSourceTypeDef
  2. See FileUseCaseType

InvokeFlowResponseTypeDef#

# InvokeFlowResponseTypeDef definition

class InvokeFlowResponseTypeDef(TypedDict):
    responseStream: EventStream[FlowResponseStreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowResponseStreamTypeDef
  2. See ResponseMetadataTypeDef

GuardrailTraceTypeDef#

# GuardrailTraceTypeDef definition

class GuardrailTraceTypeDef(TypedDict):
    action: NotRequired[GuardrailActionType],  # (1)
    inputAssessments: NotRequired[List[GuardrailAssessmentTypeDef]],  # (2)
    outputAssessments: NotRequired[List[GuardrailAssessmentTypeDef]],  # (2)
    traceId: NotRequired[str],
  1. See GuardrailActionType
  2. See GuardrailAssessmentTypeDef
  3. See GuardrailAssessmentTypeDef

ExternalSourcesRetrieveAndGenerateConfigurationTypeDef#

# ExternalSourcesRetrieveAndGenerateConfigurationTypeDef definition

class ExternalSourcesRetrieveAndGenerateConfigurationTypeDef(TypedDict):
    modelArn: str,
    sources: Sequence[ExternalSourceTypeDef],  # (2)
    generationConfiguration: NotRequired[ExternalSourcesGenerationConfigurationTypeDef],  # (1)
  1. See ExternalSourcesGenerationConfigurationTypeDef
  2. See ExternalSourceTypeDef

KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef#

# KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef definition

class KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef(TypedDict):
    knowledgeBaseId: str,
    modelArn: str,
    generationConfiguration: NotRequired[GenerationConfigurationTypeDef],  # (1)
    orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef],  # (2)
    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef],  # (3)
  1. See GenerationConfigurationTypeDef
  2. See OrchestrationConfigurationTypeDef
  3. See KnowledgeBaseRetrievalConfigurationTypeDef

RetrieveResponseTypeDef#

# RetrieveResponseTypeDef definition

class RetrieveResponseTypeDef(TypedDict):
    nextToken: str,
    retrievalResults: List[KnowledgeBaseRetrievalResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseRetrievalResultTypeDef
  2. See ResponseMetadataTypeDef

KnowledgeBaseLookupOutputTypeDef#

# KnowledgeBaseLookupOutputTypeDef definition

class KnowledgeBaseLookupOutputTypeDef(TypedDict):
    retrievedReferences: NotRequired[List[RetrievedReferenceTypeDef]],  # (1)
  1. See RetrievedReferenceTypeDef

CitationTypeDef#

# CitationTypeDef definition

class CitationTypeDef(TypedDict):
    generatedResponsePart: NotRequired[GeneratedResponsePartTypeDef],  # (1)
    retrievedReferences: NotRequired[List[RetrievedReferenceTypeDef]],  # (2)
  1. See GeneratedResponsePartTypeDef
  2. See RetrievedReferenceTypeDef

InvocationInputMemberTypeDef#

# InvocationInputMemberTypeDef definition

class InvocationInputMemberTypeDef(TypedDict):
    apiInvocationInput: NotRequired[ApiInvocationInputTypeDef],  # (1)
    functionInvocationInput: NotRequired[FunctionInvocationInputTypeDef],  # (2)
  1. See ApiInvocationInputTypeDef
  2. See FunctionInvocationInputTypeDef

SessionStateTypeDef#

# SessionStateTypeDef definition

class SessionStateTypeDef(TypedDict):
    files: NotRequired[Sequence[InputFileTypeDef]],  # (1)
    invocationId: NotRequired[str],
    knowledgeBaseConfigurations: NotRequired[Sequence[KnowledgeBaseConfigurationTypeDef]],  # (2)
    promptSessionAttributes: NotRequired[Mapping[str, str]],
    returnControlInvocationResults: NotRequired[Sequence[InvocationResultMemberTypeDef]],  # (3)
    sessionAttributes: NotRequired[Mapping[str, str]],
  1. See InputFileTypeDef
  2. See KnowledgeBaseConfigurationTypeDef
  3. See InvocationResultMemberTypeDef

RetrieveAndGenerateConfigurationTypeDef#

# RetrieveAndGenerateConfigurationTypeDef definition

class RetrieveAndGenerateConfigurationTypeDef(TypedDict):
    type: RetrieveAndGenerateTypeType,  # (3)
    externalSourcesConfiguration: NotRequired[ExternalSourcesRetrieveAndGenerateConfigurationTypeDef],  # (1)
    knowledgeBaseConfiguration: NotRequired[KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef],  # (2)
  1. See ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
  2. See KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
  3. See RetrieveAndGenerateTypeType

ObservationTypeDef#

# ObservationTypeDef definition

class ObservationTypeDef(TypedDict):
    actionGroupInvocationOutput: NotRequired[ActionGroupInvocationOutputTypeDef],  # (1)
    codeInterpreterInvocationOutput: NotRequired[CodeInterpreterInvocationOutputTypeDef],  # (2)
    finalResponse: NotRequired[FinalResponseTypeDef],  # (3)
    knowledgeBaseLookupOutput: NotRequired[KnowledgeBaseLookupOutputTypeDef],  # (4)
    repromptResponse: NotRequired[RepromptResponseTypeDef],  # (5)
    traceId: NotRequired[str],
    type: NotRequired[TypeType],  # (6)
  1. See ActionGroupInvocationOutputTypeDef
  2. See CodeInterpreterInvocationOutputTypeDef
  3. See FinalResponseTypeDef
  4. See KnowledgeBaseLookupOutputTypeDef
  5. See RepromptResponseTypeDef
  6. See TypeType

AttributionTypeDef#

# AttributionTypeDef definition

class AttributionTypeDef(TypedDict):
    citations: NotRequired[List[CitationTypeDef]],  # (1)
  1. See CitationTypeDef

RetrieveAndGenerateResponseTypeDef#

# RetrieveAndGenerateResponseTypeDef definition

class RetrieveAndGenerateResponseTypeDef(TypedDict):
    citations: List[CitationTypeDef],  # (1)
    guardrailAction: GuadrailActionType,  # (2)
    output: RetrieveAndGenerateOutputTypeDef,  # (3)
    sessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CitationTypeDef
  2. See GuadrailActionType
  3. See RetrieveAndGenerateOutputTypeDef
  4. See ResponseMetadataTypeDef

ReturnControlPayloadTypeDef#

# ReturnControlPayloadTypeDef definition

class ReturnControlPayloadTypeDef(TypedDict):
    invocationId: NotRequired[str],
    invocationInputs: NotRequired[List[InvocationInputMemberTypeDef]],  # (1)
  1. See InvocationInputMemberTypeDef

InvokeAgentRequestRequestTypeDef#

# InvokeAgentRequestRequestTypeDef definition

class InvokeAgentRequestRequestTypeDef(TypedDict):
    agentAliasId: str,
    agentId: str,
    sessionId: str,
    enableTrace: NotRequired[bool],
    endSession: NotRequired[bool],
    inputText: NotRequired[str],
    memoryId: NotRequired[str],
    sessionState: NotRequired[SessionStateTypeDef],  # (1)
  1. See SessionStateTypeDef

RetrieveAndGenerateRequestRequestTypeDef#

# RetrieveAndGenerateRequestRequestTypeDef definition

class RetrieveAndGenerateRequestRequestTypeDef(TypedDict):
    input: RetrieveAndGenerateInputTypeDef,  # (1)
    retrieveAndGenerateConfiguration: NotRequired[RetrieveAndGenerateConfigurationTypeDef],  # (2)
    sessionConfiguration: NotRequired[RetrieveAndGenerateSessionConfigurationTypeDef],  # (3)
    sessionId: NotRequired[str],
  1. See RetrieveAndGenerateInputTypeDef
  2. See RetrieveAndGenerateConfigurationTypeDef
  3. See RetrieveAndGenerateSessionConfigurationTypeDef

OrchestrationTraceTypeDef#

# OrchestrationTraceTypeDef definition

class OrchestrationTraceTypeDef(TypedDict):
    invocationInput: NotRequired[InvocationInputTypeDef],  # (1)
    modelInvocationInput: NotRequired[ModelInvocationInputTypeDef],  # (2)
    observation: NotRequired[ObservationTypeDef],  # (3)
    rationale: NotRequired[RationaleTypeDef],  # (4)
  1. See InvocationInputTypeDef
  2. See ModelInvocationInputTypeDef
  3. See ObservationTypeDef
  4. See RationaleTypeDef

PayloadPartTypeDef#

# PayloadPartTypeDef definition

class PayloadPartTypeDef(TypedDict):
    attribution: NotRequired[AttributionTypeDef],  # (1)
    bytes: NotRequired[bytes],
  1. See AttributionTypeDef

TraceTypeDef#

# TraceTypeDef definition

class TraceTypeDef(TypedDict):
    failureTrace: NotRequired[FailureTraceTypeDef],  # (1)
    guardrailTrace: NotRequired[GuardrailTraceTypeDef],  # (2)
    orchestrationTrace: NotRequired[OrchestrationTraceTypeDef],  # (3)
    postProcessingTrace: NotRequired[PostProcessingTraceTypeDef],  # (4)
    preProcessingTrace: NotRequired[PreProcessingTraceTypeDef],  # (5)
  1. See FailureTraceTypeDef
  2. See GuardrailTraceTypeDef
  3. See OrchestrationTraceTypeDef
  4. See PostProcessingTraceTypeDef
  5. See PreProcessingTraceTypeDef

TracePartTypeDef#

# TracePartTypeDef definition

class TracePartTypeDef(TypedDict):
    agentAliasId: NotRequired[str],
    agentId: NotRequired[str],
    agentVersion: NotRequired[str],
    sessionId: NotRequired[str],
    trace: NotRequired[TraceTypeDef],  # (1)
  1. See TraceTypeDef

ResponseStreamTypeDef#

# 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)
    resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef],  # (8)
    returnControl: NotRequired[ReturnControlPayloadTypeDef],  # (9)
    serviceQuotaExceededException: NotRequired[ServiceQuotaExceededExceptionTypeDef],  # (10)
    throttlingException: NotRequired[ThrottlingExceptionTypeDef],  # (11)
    trace: NotRequired[TracePartTypeDef],  # (12)
    validationException: NotRequired[ValidationExceptionTypeDef],  # (13)
  1. See AccessDeniedExceptionTypeDef
  2. See BadGatewayExceptionTypeDef
  3. See PayloadPartTypeDef
  4. See ConflictExceptionTypeDef
  5. See DependencyFailedExceptionTypeDef
  6. See FilePartTypeDef
  7. See InternalServerExceptionTypeDef
  8. See ResourceNotFoundExceptionTypeDef
  9. See ReturnControlPayloadTypeDef
  10. See ServiceQuotaExceededExceptionTypeDef
  11. See ThrottlingExceptionTypeDef
  12. See TracePartTypeDef
  13. See ValidationExceptionTypeDef

InvokeAgentResponseTypeDef#

# InvokeAgentResponseTypeDef definition

class InvokeAgentResponseTypeDef(TypedDict):
    completion: EventStream[ResponseStreamTypeDef],  # (1)
    contentType: str,
    memoryId: str,
    sessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResponseStreamTypeDef
  2. See ResponseMetadataTypeDef