2025/09/26 - Agents for Amazon Bedrock Runtime - 2 updated api methods
Changes This release enhances the information provided through Flow Traces. New information includes source/next node tracking, execution chains for complex nodes, dependency action (operation) details, and dependency traces.
{'responseStream': {'flowTraceEvent': {'trace': {'nodeActionTrace': {'operationRequest': {},
'operationResponse': {}},
'nodeDependencyTrace': {'nodeName': 'string',
'timestamp': 'timestamp',
'traceElements': {'agentTraces': [{'agentAliasId': 'string',
'agentId': 'string',
'agentVersion': 'string',
'callerChain': [{'agentAliasArn': 'string'}],
'collaboratorName': 'string',
'eventTime': 'timestamp',
'sessionId': 'string',
'trace': {'customOrchestrationTrace': {'event': {'text': 'string'},
'traceId': 'string'},
'failureTrace': {'failureCode': 'integer',
'failureReason': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'traceId': 'string'},
'guardrailTrace': {'action': 'INTERVENED '
'| '
'NONE',
'inputAssessments': [{'contentPolicy': {'filters': [{'action': 'BLOCKED',
'confidence': 'NONE '
'| '
'LOW '
'| '
'MEDIUM '
'| '
'HIGH',
'type': 'INSULTS '
'| '
'HATE '
'| '
'SEXUAL '
'| '
'VIOLENCE '
'| '
'MISCONDUCT '
'| '
'PROMPT_ATTACK'}]},
'sensitiveInformationPolicy': {'piiEntities': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'type': 'ADDRESS '
'| '
'AGE '
'| '
'AWS_ACCESS_KEY '
'| '
'AWS_SECRET_KEY '
'| '
'CA_HEALTH_NUMBER '
'| '
'CA_SOCIAL_INSURANCE_NUMBER '
'| '
'CREDIT_DEBIT_CARD_CVV '
'| '
'CREDIT_DEBIT_CARD_EXPIRY '
'| '
'CREDIT_DEBIT_CARD_NUMBER '
'| '
'DRIVER_ID '
'| '
'EMAIL '
'| '
'INTERNATIONAL_BANK_ACCOUNT_NUMBER '
'| '
'IP_ADDRESS '
'| '
'LICENSE_PLATE '
'| '
'MAC_ADDRESS '
'| '
'NAME '
'| '
'PASSWORD '
'| '
'PHONE '
'| '
'PIN '
'| '
'SWIFT_CODE '
'| '
'UK_NATIONAL_HEALTH_SERVICE_NUMBER '
'| '
'UK_NATIONAL_INSURANCE_NUMBER '
'| '
'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER '
'| '
'URL '
'| '
'USERNAME '
'| '
'US_BANK_ACCOUNT_NUMBER '
'| '
'US_BANK_ROUTING_NUMBER '
'| '
'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER '
'| '
'US_PASSPORT_NUMBER '
'| '
'US_SOCIAL_SECURITY_NUMBER '
'| '
'VEHICLE_IDENTIFICATION_NUMBER'}],
'regexes': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'name': 'string',
'regex': 'string'}]},
'topicPolicy': {'topics': [{'action': 'BLOCKED',
'name': 'string',
'type': 'DENY'}]},
'wordPolicy': {'customWords': [{'action': 'BLOCKED',
'match': 'string'}],
'managedWordLists': [{'action': 'BLOCKED',
'match': 'string',
'type': 'PROFANITY'}]}}],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'outputAssessments': [{'contentPolicy': {'filters': [{'action': 'BLOCKED',
'confidence': 'NONE '
'| '
'LOW '
'| '
'MEDIUM '
'| '
'HIGH',
'type': 'INSULTS '
'| '
'HATE '
'| '
'SEXUAL '
'| '
'VIOLENCE '
'| '
'MISCONDUCT '
'| '
'PROMPT_ATTACK'}]},
'sensitiveInformationPolicy': {'piiEntities': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'type': 'ADDRESS '
'| '
'AGE '
'| '
'AWS_ACCESS_KEY '
'| '
'AWS_SECRET_KEY '
'| '
'CA_HEALTH_NUMBER '
'| '
'CA_SOCIAL_INSURANCE_NUMBER '
'| '
'CREDIT_DEBIT_CARD_CVV '
'| '
'CREDIT_DEBIT_CARD_EXPIRY '
'| '
'CREDIT_DEBIT_CARD_NUMBER '
'| '
'DRIVER_ID '
'| '
'EMAIL '
'| '
'INTERNATIONAL_BANK_ACCOUNT_NUMBER '
'| '
'IP_ADDRESS '
'| '
'LICENSE_PLATE '
'| '
'MAC_ADDRESS '
'| '
'NAME '
'| '
'PASSWORD '
'| '
'PHONE '
'| '
'PIN '
'| '
'SWIFT_CODE '
'| '
'UK_NATIONAL_HEALTH_SERVICE_NUMBER '
'| '
'UK_NATIONAL_INSURANCE_NUMBER '
'| '
'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER '
'| '
'URL '
'| '
'USERNAME '
'| '
'US_BANK_ACCOUNT_NUMBER '
'| '
'US_BANK_ROUTING_NUMBER '
'| '
'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER '
'| '
'US_PASSPORT_NUMBER '
'| '
'US_SOCIAL_SECURITY_NUMBER '
'| '
'VEHICLE_IDENTIFICATION_NUMBER'}],
'regexes': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'name': 'string',
'regex': 'string'}]},
'topicPolicy': {'topics': [{'action': 'BLOCKED',
'name': 'string',
'type': 'DENY'}]},
'wordPolicy': {'customWords': [{'action': 'BLOCKED',
'match': 'string'}],
'managedWordLists': [{'action': 'BLOCKED',
'match': 'string',
'type': 'PROFANITY'}]}}],
'traceId': 'string'},
'orchestrationTrace': {'invocationInput': {'actionGroupInvocationInput': {'actionGroupName': 'string',
'apiPath': 'string',
'executionType': 'LAMBDA '
'| '
'RETURN_CONTROL',
'function': 'string',
'invocationId': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': [{'name': 'string',
'type': 'string',
'value': 'string'}]}},
'verb': 'string'},
'agentCollaboratorInvocationInput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'input': {'returnControlResults': {'invocationId': 'string',
'returnControlInvocationResults': [{'apiResult': {'actionGroup': 'string',
'agentId': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'httpMethod': 'string',
'httpStatusCode': 'integer',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'},
'functionResult': {'actionGroup': 'string',
'agentId': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'function': 'string',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationInput': {'code': 'string',
'files': ['string']},
'invocationType': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ACTION_GROUP_CODE_INTERPRETER '
'| '
'AGENT_COLLABORATOR',
'knowledgeBaseLookupInput': {'knowledgeBaseId': 'string',
'text': 'string'},
'traceId': 'string'},
'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'},
'observation': {'actionGroupInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'agentCollaboratorInvocationOutput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'output': {'returnControlPayload': {'invocationId': 'string',
'invocationInputs': [{'apiInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'apiPath': 'string',
'collaboratorName': 'string',
'httpMethod': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': {'properties': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}}},
'functionInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string',
'function': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationOutput': {'executionError': 'string',
'executionOutput': 'string',
'executionTimeout': 'boolean',
'files': ['string'],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}}},
'finalResponse': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'knowledgeBaseLookupOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'retrievedReferences': [{'content': {'byteContent': 'string',
'row': [{'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB '
'| '
'BOOLEAN '
'| '
'DOUBLE '
'| '
'NULL '
'| '
'LONG '
'| '
'STRING'}],
'text': 'string',
'type': 'TEXT '
'| '
'IMAGE '
'| '
'ROW'},
'location': {'confluenceLocation': {'url': 'string'},
'customDocumentLocation': {'id': 'string'},
'kendraDocumentLocation': {'uri': 'string'},
's3Location': {'uri': 'string'},
'salesforceLocation': {'url': 'string'},
'sharePointLocation': {'url': 'string'},
'sqlLocation': {'query': 'string'},
'type': 'S3 '
'| '
'WEB '
'| '
'CONFLUENCE '
'| '
'SALESFORCE '
'| '
'SHAREPOINT '
'| '
'CUSTOM '
'| '
'KENDRA '
'| '
'SQL',
'webLocation': {'url': 'string'}},
'metadata': {'string': {}}}]},
'repromptResponse': {'source': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'PARSER',
'text': 'string'},
'traceId': 'string',
'type': 'ACTION_GROUP '
'| '
'AGENT_COLLABORATOR '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ASK_USER '
'| '
'REPROMPT'},
'rationale': {'text': 'string',
'traceId': 'string'}},
'postProcessingTrace': {'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'parsedResponse': {'text': 'string'},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'}},
'preProcessingTrace': {'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'parsedResponse': {'isValid': 'boolean',
'rationale': 'string'},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'}},
'routingClassifierTrace': {'invocationInput': {'actionGroupInvocationInput': {'actionGroupName': 'string',
'apiPath': 'string',
'executionType': 'LAMBDA '
'| '
'RETURN_CONTROL',
'function': 'string',
'invocationId': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': [{'name': 'string',
'type': 'string',
'value': 'string'}]}},
'verb': 'string'},
'agentCollaboratorInvocationInput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'input': {'returnControlResults': {'invocationId': 'string',
'returnControlInvocationResults': [{'apiResult': {'actionGroup': 'string',
'agentId': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'httpMethod': 'string',
'httpStatusCode': 'integer',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'},
'functionResult': {'actionGroup': 'string',
'agentId': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'function': 'string',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationInput': {'code': 'string',
'files': ['string']},
'invocationType': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ACTION_GROUP_CODE_INTERPRETER '
'| '
'AGENT_COLLABORATOR',
'knowledgeBaseLookupInput': {'knowledgeBaseId': 'string',
'text': 'string'},
'traceId': 'string'},
'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'rawResponse': {'content': 'string'},
'traceId': 'string'},
'observation': {'actionGroupInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'agentCollaboratorInvocationOutput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'output': {'returnControlPayload': {'invocationId': 'string',
'invocationInputs': [{'apiInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'apiPath': 'string',
'collaboratorName': 'string',
'httpMethod': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': {'properties': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}}},
'functionInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string',
'function': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationOutput': {'executionError': 'string',
'executionOutput': 'string',
'executionTimeout': 'boolean',
'files': ['string'],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}}},
'finalResponse': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'knowledgeBaseLookupOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'retrievedReferences': [{'content': {'byteContent': 'string',
'row': [{'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB '
'| '
'BOOLEAN '
'| '
'DOUBLE '
'| '
'NULL '
'| '
'LONG '
'| '
'STRING'}],
'text': 'string',
'type': 'TEXT '
'| '
'IMAGE '
'| '
'ROW'},
'location': {'confluenceLocation': {'url': 'string'},
'customDocumentLocation': {'id': 'string'},
'kendraDocumentLocation': {'uri': 'string'},
's3Location': {'uri': 'string'},
'salesforceLocation': {'url': 'string'},
'sharePointLocation': {'url': 'string'},
'sqlLocation': {'query': 'string'},
'type': 'S3 '
'| '
'WEB '
'| '
'CONFLUENCE '
'| '
'SALESFORCE '
'| '
'SHAREPOINT '
'| '
'CUSTOM '
'| '
'KENDRA '
'| '
'SQL',
'webLocation': {'url': 'string'}},
'metadata': {'string': {}}}]},
'repromptResponse': {'source': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'PARSER',
'text': 'string'},
'traceId': 'string',
'type': 'ACTION_GROUP '
'| '
'AGENT_COLLABORATOR '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ASK_USER '
'| '
'REPROMPT'}}}}]}},
'nodeInputTrace': {'fields': {'category': 'LoopCondition '
'| '
'ReturnValueToLoopStart '
'| '
'ExitLoop',
'executionChain': [{'index': 'integer',
'nodeName': 'string',
'type': 'Iterator '
'| '
'Loop'}],
'source': {'expression': 'string',
'nodeName': 'string',
'outputFieldName': 'string'},
'type': 'String '
'| '
'Number '
'| '
'Boolean '
'| '
'Object '
'| '
'Array'}},
'nodeOutputTrace': {'fields': {'next': [{'inputFieldName': 'string',
'nodeName': 'string'}],
'type': 'String '
'| '
'Number '
'| '
'Boolean '
'| '
'Object '
'| '
'Array'}}}}}}
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
See also: AWS API Documentation
Request Syntax
client.invoke_flow(
flowIdentifier='string',
flowAliasIdentifier='string',
inputs=[
{
'nodeName': 'string',
'nodeOutputName': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
},
'nodeInputName': 'string'
},
],
enableTrace=True|False,
modelPerformanceConfiguration={
'performanceConfig': {
'latency': 'standard'|'optimized'
}
},
executionId='string'
)
string
[REQUIRED]
The unique identifier of the flow.
string
[REQUIRED]
The unique identifier of the flow alias.
list
[REQUIRED]
A list of objects, each containing information about an input into the flow.
(dict) --
Contains information about an input into the prompt flow and where to send it.
nodeName (string) -- [REQUIRED]
The name of the flow input node that begins the prompt flow.
nodeOutputName (string) --
The name of the output from the flow input node that begins the prompt flow.
content (dict) -- [REQUIRED]
Contains information about an input into the prompt flow.
document (:ref:`document<document>`) --
The input to send to the prompt flow input node.
nodeInputName (string) --
The name of the input from the flow input node.
boolean
Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
dict
Model performance settings for the request.
performanceConfig (dict) --
The latency configuration for the model.
latency (string) --
To use a latency-optimized version of the model, set to optimized.
string
The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
dict
The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.
Response Syntax
{
'responseStream': EventStream({
'flowOutputEvent': {
'nodeName': 'string',
'nodeType': 'FlowInputNode'|'FlowOutputNode'|'LambdaFunctionNode'|'KnowledgeBaseNode'|'PromptNode'|'ConditionNode'|'LexNode',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
}
},
'flowCompletionEvent': {
'completionReason': 'SUCCESS'|'INPUT_REQUIRED'
},
'flowTraceEvent': {
'trace': {
'nodeInputTrace': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'nodeInputName': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
},
'source': {
'nodeName': 'string',
'outputFieldName': 'string',
'expression': 'string'
},
'type': 'String'|'Number'|'Boolean'|'Object'|'Array',
'category': 'LoopCondition'|'ReturnValueToLoopStart'|'ExitLoop',
'executionChain': [
{
'nodeName': 'string',
'index': 123,
'type': 'Iterator'|'Loop'
},
]
},
]
},
'nodeOutputTrace': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'nodeOutputName': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
},
'next': [
{
'nodeName': 'string',
'inputFieldName': 'string'
},
],
'type': 'String'|'Number'|'Boolean'|'Object'|'Array'
},
]
},
'conditionNodeResultTrace': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'satisfiedConditions': [
{
'conditionName': 'string'
},
]
},
'nodeActionTrace': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'requestId': 'string',
'serviceName': 'string',
'operationName': 'string',
'operationRequest': {...}|[...]|123|123.4|'string'|True|None,
'operationResponse': {...}|[...]|123|123.4|'string'|True|None
},
'nodeDependencyTrace': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'traceElements': {
'agentTraces': [
{
'sessionId': 'string',
'trace': {
'guardrailTrace': {
'action': 'INTERVENED'|'NONE',
'traceId': 'string',
'inputAssessments': [
{
'topicPolicy': {
'topics': [
{
'name': 'string',
'type': 'DENY',
'action': 'BLOCKED'
},
]
},
'contentPolicy': {
'filters': [
{
'type': 'INSULTS'|'HATE'|'SEXUAL'|'VIOLENCE'|'MISCONDUCT'|'PROMPT_ATTACK',
'confidence': 'NONE'|'LOW'|'MEDIUM'|'HIGH',
'action': 'BLOCKED'
},
]
},
'wordPolicy': {
'customWords': [
{
'match': 'string',
'action': 'BLOCKED'
},
],
'managedWordLists': [
{
'match': 'string',
'type': 'PROFANITY',
'action': 'BLOCKED'
},
]
},
'sensitiveInformationPolicy': {
'piiEntities': [
{
'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
],
'regexes': [
{
'name': 'string',
'regex': 'string',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
]
}
},
],
'outputAssessments': [
{
'topicPolicy': {
'topics': [
{
'name': 'string',
'type': 'DENY',
'action': 'BLOCKED'
},
]
},
'contentPolicy': {
'filters': [
{
'type': 'INSULTS'|'HATE'|'SEXUAL'|'VIOLENCE'|'MISCONDUCT'|'PROMPT_ATTACK',
'confidence': 'NONE'|'LOW'|'MEDIUM'|'HIGH',
'action': 'BLOCKED'
},
]
},
'wordPolicy': {
'customWords': [
{
'match': 'string',
'action': 'BLOCKED'
},
],
'managedWordLists': [
{
'match': 'string',
'type': 'PROFANITY',
'action': 'BLOCKED'
},
]
},
'sensitiveInformationPolicy': {
'piiEntities': [
{
'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
],
'regexes': [
{
'name': 'string',
'regex': 'string',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
]
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'preProcessingTrace': {
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'parsedResponse': {
'rationale': 'string',
'isValid': True|False
},
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'orchestrationTrace': {
'rationale': {
'traceId': 'string',
'text': 'string'
},
'invocationInput': {
'traceId': 'string',
'invocationType': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'FINISH'|'ACTION_GROUP_CODE_INTERPRETER'|'AGENT_COLLABORATOR',
'actionGroupInvocationInput': {
'actionGroupName': 'string',
'verb': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
},
'function': 'string',
'executionType': 'LAMBDA'|'RETURN_CONTROL',
'invocationId': 'string'
},
'knowledgeBaseLookupInput': {
'text': 'string',
'knowledgeBaseId': 'string'
},
'codeInterpreterInvocationInput': {
'code': 'string',
'files': [
'string',
]
},
'agentCollaboratorInvocationInput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'input': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlResults': {
'invocationId': 'string',
'returnControlInvocationResults': [
{
'apiResult': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'responseState': 'FAILURE'|'REPROMPT',
'httpStatusCode': 123,
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'agentId': 'string'
},
'functionResult': {
'actionGroup': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'function': 'string',
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'responseState': 'FAILURE'|'REPROMPT',
'agentId': 'string'
}
},
]
}
}
}
},
'observation': {
'traceId': 'string',
'type': 'ACTION_GROUP'|'AGENT_COLLABORATOR'|'KNOWLEDGE_BASE'|'FINISH'|'ASK_USER'|'REPROMPT',
'actionGroupInvocationOutput': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'agentCollaboratorInvocationOutput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'output': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlPayload': {
'invocationInputs': [
{
'apiInvocationInput': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': {
'properties': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
}
},
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
},
'functionInvocationInput': {
'actionGroup': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'function': 'string',
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
}
},
],
'invocationId': 'string'
}
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'knowledgeBaseLookupOutput': {
'retrievedReferences': [
{
'content': {
'type': 'TEXT'|'IMAGE'|'ROW',
'text': 'string',
'byteContent': 'string',
'row': [
{
'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB'|'BOOLEAN'|'DOUBLE'|'NULL'|'LONG'|'STRING'
},
]
},
'location': {
'type': 'S3'|'WEB'|'CONFLUENCE'|'SALESFORCE'|'SHAREPOINT'|'CUSTOM'|'KENDRA'|'SQL',
's3Location': {
'uri': 'string'
},
'webLocation': {
'url': 'string'
},
'confluenceLocation': {
'url': 'string'
},
'salesforceLocation': {
'url': 'string'
},
'sharePointLocation': {
'url': 'string'
},
'customDocumentLocation': {
'id': 'string'
},
'kendraDocumentLocation': {
'uri': 'string'
},
'sqlLocation': {
'query': 'string'
}
},
'metadata': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'finalResponse': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'repromptResponse': {
'text': 'string',
'source': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'PARSER'
},
'codeInterpreterInvocationOutput': {
'executionOutput': 'string',
'executionError': 'string',
'files': [
'string',
],
'executionTimeout': True|False,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'postProcessingTrace': {
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'parsedResponse': {
'text': 'string'
},
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'routingClassifierTrace': {
'invocationInput': {
'traceId': 'string',
'invocationType': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'FINISH'|'ACTION_GROUP_CODE_INTERPRETER'|'AGENT_COLLABORATOR',
'actionGroupInvocationInput': {
'actionGroupName': 'string',
'verb': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
},
'function': 'string',
'executionType': 'LAMBDA'|'RETURN_CONTROL',
'invocationId': 'string'
},
'knowledgeBaseLookupInput': {
'text': 'string',
'knowledgeBaseId': 'string'
},
'codeInterpreterInvocationInput': {
'code': 'string',
'files': [
'string',
]
},
'agentCollaboratorInvocationInput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'input': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlResults': {
'invocationId': 'string',
'returnControlInvocationResults': [
{
'apiResult': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'responseState': 'FAILURE'|'REPROMPT',
'httpStatusCode': 123,
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'agentId': 'string'
},
'functionResult': {
'actionGroup': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'function': 'string',
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'responseState': 'FAILURE'|'REPROMPT',
'agentId': 'string'
}
},
]
}
}
}
},
'observation': {
'traceId': 'string',
'type': 'ACTION_GROUP'|'AGENT_COLLABORATOR'|'KNOWLEDGE_BASE'|'FINISH'|'ASK_USER'|'REPROMPT',
'actionGroupInvocationOutput': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'agentCollaboratorInvocationOutput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'output': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlPayload': {
'invocationInputs': [
{
'apiInvocationInput': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': {
'properties': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
}
},
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
},
'functionInvocationInput': {
'actionGroup': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'function': 'string',
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
}
},
],
'invocationId': 'string'
}
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'knowledgeBaseLookupOutput': {
'retrievedReferences': [
{
'content': {
'type': 'TEXT'|'IMAGE'|'ROW',
'text': 'string',
'byteContent': 'string',
'row': [
{
'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB'|'BOOLEAN'|'DOUBLE'|'NULL'|'LONG'|'STRING'
},
]
},
'location': {
'type': 'S3'|'WEB'|'CONFLUENCE'|'SALESFORCE'|'SHAREPOINT'|'CUSTOM'|'KENDRA'|'SQL',
's3Location': {
'uri': 'string'
},
'webLocation': {
'url': 'string'
},
'confluenceLocation': {
'url': 'string'
},
'salesforceLocation': {
'url': 'string'
},
'sharePointLocation': {
'url': 'string'
},
'customDocumentLocation': {
'id': 'string'
},
'kendraDocumentLocation': {
'uri': 'string'
},
'sqlLocation': {
'query': 'string'
}
},
'metadata': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'finalResponse': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'repromptResponse': {
'text': 'string',
'source': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'PARSER'
},
'codeInterpreterInvocationOutput': {
'executionOutput': 'string',
'executionError': 'string',
'files': [
'string',
],
'executionTimeout': True|False,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'failureTrace': {
'traceId': 'string',
'failureReason': 'string',
'failureCode': 123,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'customOrchestrationTrace': {
'traceId': 'string',
'event': {
'text': 'string'
}
}
},
'callerChain': [
{
'agentAliasArn': 'string'
},
],
'eventTime': datetime(2015, 1, 1),
'collaboratorName': 'string',
'agentId': 'string',
'agentAliasId': 'string',
'agentVersion': 'string'
},
]
}
}
}
},
'internalServerException': {
'message': 'string',
'reason': 'string'
},
'validationException': {
'message': 'string'
},
'resourceNotFoundException': {
'message': 'string'
},
'serviceQuotaExceededException': {
'message': 'string'
},
'throttlingException': {
'message': 'string'
},
'accessDeniedException': {
'message': 'string'
},
'conflictException': {
'message': 'string'
},
'dependencyFailedException': {
'message': 'string',
'resourceName': 'string'
},
'badGatewayException': {
'message': 'string',
'resourceName': 'string'
},
'flowMultiTurnInputRequestEvent': {
'nodeName': 'string',
'nodeType': 'FlowInputNode'|'FlowOutputNode'|'LambdaFunctionNode'|'KnowledgeBaseNode'|'PromptNode'|'ConditionNode'|'LexNode',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
}
}
}),
'executionId': 'string'
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlow>`_
{'flowExecutionEvents': {'nodeActionEvent': {'nodeName': 'string',
'operationName': 'string',
'operationRequest': {},
'operationResponse': {},
'requestId': 'string',
'serviceName': 'string',
'timestamp': 'timestamp'},
'nodeDependencyEvent': {'nodeName': 'string',
'timestamp': 'timestamp',
'traceElements': {'agentTraces': [{'agentAliasId': 'string',
'agentId': 'string',
'agentVersion': 'string',
'callerChain': [{'agentAliasArn': 'string'}],
'collaboratorName': 'string',
'eventTime': 'timestamp',
'sessionId': 'string',
'trace': {'customOrchestrationTrace': {'event': {'text': 'string'},
'traceId': 'string'},
'failureTrace': {'failureCode': 'integer',
'failureReason': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'traceId': 'string'},
'guardrailTrace': {'action': 'INTERVENED '
'| '
'NONE',
'inputAssessments': [{'contentPolicy': {'filters': [{'action': 'BLOCKED',
'confidence': 'NONE '
'| '
'LOW '
'| '
'MEDIUM '
'| '
'HIGH',
'type': 'INSULTS '
'| '
'HATE '
'| '
'SEXUAL '
'| '
'VIOLENCE '
'| '
'MISCONDUCT '
'| '
'PROMPT_ATTACK'}]},
'sensitiveInformationPolicy': {'piiEntities': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'type': 'ADDRESS '
'| '
'AGE '
'| '
'AWS_ACCESS_KEY '
'| '
'AWS_SECRET_KEY '
'| '
'CA_HEALTH_NUMBER '
'| '
'CA_SOCIAL_INSURANCE_NUMBER '
'| '
'CREDIT_DEBIT_CARD_CVV '
'| '
'CREDIT_DEBIT_CARD_EXPIRY '
'| '
'CREDIT_DEBIT_CARD_NUMBER '
'| '
'DRIVER_ID '
'| '
'EMAIL '
'| '
'INTERNATIONAL_BANK_ACCOUNT_NUMBER '
'| '
'IP_ADDRESS '
'| '
'LICENSE_PLATE '
'| '
'MAC_ADDRESS '
'| '
'NAME '
'| '
'PASSWORD '
'| '
'PHONE '
'| '
'PIN '
'| '
'SWIFT_CODE '
'| '
'UK_NATIONAL_HEALTH_SERVICE_NUMBER '
'| '
'UK_NATIONAL_INSURANCE_NUMBER '
'| '
'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER '
'| '
'URL '
'| '
'USERNAME '
'| '
'US_BANK_ACCOUNT_NUMBER '
'| '
'US_BANK_ROUTING_NUMBER '
'| '
'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER '
'| '
'US_PASSPORT_NUMBER '
'| '
'US_SOCIAL_SECURITY_NUMBER '
'| '
'VEHICLE_IDENTIFICATION_NUMBER'}],
'regexes': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'name': 'string',
'regex': 'string'}]},
'topicPolicy': {'topics': [{'action': 'BLOCKED',
'name': 'string',
'type': 'DENY'}]},
'wordPolicy': {'customWords': [{'action': 'BLOCKED',
'match': 'string'}],
'managedWordLists': [{'action': 'BLOCKED',
'match': 'string',
'type': 'PROFANITY'}]}}],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'outputAssessments': [{'contentPolicy': {'filters': [{'action': 'BLOCKED',
'confidence': 'NONE '
'| '
'LOW '
'| '
'MEDIUM '
'| '
'HIGH',
'type': 'INSULTS '
'| '
'HATE '
'| '
'SEXUAL '
'| '
'VIOLENCE '
'| '
'MISCONDUCT '
'| '
'PROMPT_ATTACK'}]},
'sensitiveInformationPolicy': {'piiEntities': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'type': 'ADDRESS '
'| '
'AGE '
'| '
'AWS_ACCESS_KEY '
'| '
'AWS_SECRET_KEY '
'| '
'CA_HEALTH_NUMBER '
'| '
'CA_SOCIAL_INSURANCE_NUMBER '
'| '
'CREDIT_DEBIT_CARD_CVV '
'| '
'CREDIT_DEBIT_CARD_EXPIRY '
'| '
'CREDIT_DEBIT_CARD_NUMBER '
'| '
'DRIVER_ID '
'| '
'EMAIL '
'| '
'INTERNATIONAL_BANK_ACCOUNT_NUMBER '
'| '
'IP_ADDRESS '
'| '
'LICENSE_PLATE '
'| '
'MAC_ADDRESS '
'| '
'NAME '
'| '
'PASSWORD '
'| '
'PHONE '
'| '
'PIN '
'| '
'SWIFT_CODE '
'| '
'UK_NATIONAL_HEALTH_SERVICE_NUMBER '
'| '
'UK_NATIONAL_INSURANCE_NUMBER '
'| '
'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER '
'| '
'URL '
'| '
'USERNAME '
'| '
'US_BANK_ACCOUNT_NUMBER '
'| '
'US_BANK_ROUTING_NUMBER '
'| '
'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER '
'| '
'US_PASSPORT_NUMBER '
'| '
'US_SOCIAL_SECURITY_NUMBER '
'| '
'VEHICLE_IDENTIFICATION_NUMBER'}],
'regexes': [{'action': 'BLOCKED '
'| '
'ANONYMIZED',
'match': 'string',
'name': 'string',
'regex': 'string'}]},
'topicPolicy': {'topics': [{'action': 'BLOCKED',
'name': 'string',
'type': 'DENY'}]},
'wordPolicy': {'customWords': [{'action': 'BLOCKED',
'match': 'string'}],
'managedWordLists': [{'action': 'BLOCKED',
'match': 'string',
'type': 'PROFANITY'}]}}],
'traceId': 'string'},
'orchestrationTrace': {'invocationInput': {'actionGroupInvocationInput': {'actionGroupName': 'string',
'apiPath': 'string',
'executionType': 'LAMBDA '
'| '
'RETURN_CONTROL',
'function': 'string',
'invocationId': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': [{'name': 'string',
'type': 'string',
'value': 'string'}]}},
'verb': 'string'},
'agentCollaboratorInvocationInput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'input': {'returnControlResults': {'invocationId': 'string',
'returnControlInvocationResults': [{'apiResult': {'actionGroup': 'string',
'agentId': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'httpMethod': 'string',
'httpStatusCode': 'integer',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'},
'functionResult': {'actionGroup': 'string',
'agentId': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'function': 'string',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationInput': {'code': 'string',
'files': ['string']},
'invocationType': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ACTION_GROUP_CODE_INTERPRETER '
'| '
'AGENT_COLLABORATOR',
'knowledgeBaseLookupInput': {'knowledgeBaseId': 'string',
'text': 'string'},
'traceId': 'string'},
'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'},
'observation': {'actionGroupInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'agentCollaboratorInvocationOutput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'output': {'returnControlPayload': {'invocationId': 'string',
'invocationInputs': [{'apiInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'apiPath': 'string',
'collaboratorName': 'string',
'httpMethod': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': {'properties': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}}},
'functionInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string',
'function': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationOutput': {'executionError': 'string',
'executionOutput': 'string',
'executionTimeout': 'boolean',
'files': ['string'],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}}},
'finalResponse': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'knowledgeBaseLookupOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'retrievedReferences': [{'content': {'byteContent': 'string',
'row': [{'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB '
'| '
'BOOLEAN '
'| '
'DOUBLE '
'| '
'NULL '
'| '
'LONG '
'| '
'STRING'}],
'text': 'string',
'type': 'TEXT '
'| '
'IMAGE '
'| '
'ROW'},
'location': {'confluenceLocation': {'url': 'string'},
'customDocumentLocation': {'id': 'string'},
'kendraDocumentLocation': {'uri': 'string'},
's3Location': {'uri': 'string'},
'salesforceLocation': {'url': 'string'},
'sharePointLocation': {'url': 'string'},
'sqlLocation': {'query': 'string'},
'type': 'S3 '
'| '
'WEB '
'| '
'CONFLUENCE '
'| '
'SALESFORCE '
'| '
'SHAREPOINT '
'| '
'CUSTOM '
'| '
'KENDRA '
'| '
'SQL',
'webLocation': {'url': 'string'}},
'metadata': {'string': {}}}]},
'repromptResponse': {'source': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'PARSER',
'text': 'string'},
'traceId': 'string',
'type': 'ACTION_GROUP '
'| '
'AGENT_COLLABORATOR '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ASK_USER '
'| '
'REPROMPT'},
'rationale': {'text': 'string',
'traceId': 'string'}},
'postProcessingTrace': {'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'parsedResponse': {'text': 'string'},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'}},
'preProcessingTrace': {'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'parsedResponse': {'isValid': 'boolean',
'rationale': 'string'},
'rawResponse': {'content': 'string'},
'reasoningContent': {'reasoningText': {'signature': 'string',
'text': 'string'},
'redactedContent': 'blob'},
'traceId': 'string'}},
'routingClassifierTrace': {'invocationInput': {'actionGroupInvocationInput': {'actionGroupName': 'string',
'apiPath': 'string',
'executionType': 'LAMBDA '
'| '
'RETURN_CONTROL',
'function': 'string',
'invocationId': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': [{'name': 'string',
'type': 'string',
'value': 'string'}]}},
'verb': 'string'},
'agentCollaboratorInvocationInput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'input': {'returnControlResults': {'invocationId': 'string',
'returnControlInvocationResults': [{'apiResult': {'actionGroup': 'string',
'agentId': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'httpMethod': 'string',
'httpStatusCode': 'integer',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'},
'functionResult': {'actionGroup': 'string',
'agentId': 'string',
'confirmationState': 'CONFIRM '
'| '
'DENY',
'function': 'string',
'responseBody': {'string': {'body': 'string',
'images': [{'format': 'png '
'| '
'jpeg '
'| '
'gif '
'| '
'webp',
'source': {'bytes': 'blob'}}]}},
'responseState': 'FAILURE '
'| '
'REPROMPT'}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationInput': {'code': 'string',
'files': ['string']},
'invocationType': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ACTION_GROUP_CODE_INTERPRETER '
'| '
'AGENT_COLLABORATOR',
'knowledgeBaseLookupInput': {'knowledgeBaseId': 'string',
'text': 'string'},
'traceId': 'string'},
'modelInvocationInput': {'foundationModel': 'string',
'inferenceConfiguration': {'maximumLength': 'integer',
'stopSequences': ['string'],
'temperature': 'float',
'topK': 'integer',
'topP': 'float'},
'overrideLambda': 'string',
'parserMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'promptCreationMode': 'DEFAULT '
'| '
'OVERRIDDEN',
'text': 'string',
'traceId': 'string',
'type': 'PRE_PROCESSING '
'| '
'ORCHESTRATION '
'| '
'KNOWLEDGE_BASE_RESPONSE_GENERATION '
'| '
'POST_PROCESSING '
'| '
'ROUTING_CLASSIFIER'},
'modelInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'rawResponse': {'content': 'string'},
'traceId': 'string'},
'observation': {'actionGroupInvocationOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'agentCollaboratorInvocationOutput': {'agentCollaboratorAliasArn': 'string',
'agentCollaboratorName': 'string',
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'output': {'returnControlPayload': {'invocationId': 'string',
'invocationInputs': [{'apiInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'apiPath': 'string',
'collaboratorName': 'string',
'httpMethod': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}],
'requestBody': {'content': {'string': {'properties': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}}},
'functionInvocationInput': {'actionGroup': 'string',
'actionInvocationType': 'RESULT '
'| '
'USER_CONFIRMATION '
'| '
'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string',
'function': 'string',
'parameters': [{'name': 'string',
'type': 'string',
'value': 'string'}]}}]},
'text': 'string',
'type': 'TEXT '
'| '
'RETURN_CONTROL'}},
'codeInterpreterInvocationOutput': {'executionError': 'string',
'executionOutput': 'string',
'executionTimeout': 'boolean',
'files': ['string'],
'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}}},
'finalResponse': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'text': 'string'},
'knowledgeBaseLookupOutput': {'metadata': {'clientRequestId': 'string',
'endTime': 'timestamp',
'operationTotalTimeMs': 'long',
'startTime': 'timestamp',
'totalTimeMs': 'long',
'usage': {'inputTokens': 'integer',
'outputTokens': 'integer'}},
'retrievedReferences': [{'content': {'byteContent': 'string',
'row': [{'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB '
'| '
'BOOLEAN '
'| '
'DOUBLE '
'| '
'NULL '
'| '
'LONG '
'| '
'STRING'}],
'text': 'string',
'type': 'TEXT '
'| '
'IMAGE '
'| '
'ROW'},
'location': {'confluenceLocation': {'url': 'string'},
'customDocumentLocation': {'id': 'string'},
'kendraDocumentLocation': {'uri': 'string'},
's3Location': {'uri': 'string'},
'salesforceLocation': {'url': 'string'},
'sharePointLocation': {'url': 'string'},
'sqlLocation': {'query': 'string'},
'type': 'S3 '
'| '
'WEB '
'| '
'CONFLUENCE '
'| '
'SALESFORCE '
'| '
'SHAREPOINT '
'| '
'CUSTOM '
'| '
'KENDRA '
'| '
'SQL',
'webLocation': {'url': 'string'}},
'metadata': {'string': {}}}]},
'repromptResponse': {'source': 'ACTION_GROUP '
'| '
'KNOWLEDGE_BASE '
'| '
'PARSER',
'text': 'string'},
'traceId': 'string',
'type': 'ACTION_GROUP '
'| '
'AGENT_COLLABORATOR '
'| '
'KNOWLEDGE_BASE '
'| '
'FINISH '
'| '
'ASK_USER '
'| '
'REPROMPT'}}}}]}},
'nodeInputEvent': {'fields': {'category': 'LoopCondition '
'| '
'ReturnValueToLoopStart '
'| ExitLoop',
'executionChain': [{'index': 'integer',
'nodeName': 'string',
'type': 'Iterator '
'| '
'Loop'}],
'source': {'expression': 'string',
'nodeName': 'string',
'outputFieldName': 'string'},
'type': 'String | '
'Number | '
'Boolean | '
'Object | '
'Array'}},
'nodeOutputEvent': {'fields': {'next': [{'inputFieldName': 'string',
'nodeName': 'string'}],
'type': 'String | '
'Number | '
'Boolean | '
'Object | '
'Array'}}}}
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
See also: AWS API Documentation
Request Syntax
client.list_flow_execution_events(
flowIdentifier='string',
flowAliasIdentifier='string',
executionIdentifier='string',
maxResults=123,
nextToken='string',
eventType='Node'|'Flow'
)
string
[REQUIRED]
The unique identifier of the flow.
string
[REQUIRED]
The unique identifier of the flow alias used for the execution.
string
[REQUIRED]
The unique identifier of the flow execution.
integer
The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
string
A token to retrieve the next set of results. This value is returned in the response if more results are available.
string
[REQUIRED]
The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
dict
Response Syntax
{
'flowExecutionEvents': [
{
'flowInputEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'name': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
}
},
]
},
'flowOutputEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'name': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
}
},
]
},
'nodeInputEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'name': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
},
'source': {
'nodeName': 'string',
'outputFieldName': 'string',
'expression': 'string'
},
'type': 'String'|'Number'|'Boolean'|'Object'|'Array',
'category': 'LoopCondition'|'ReturnValueToLoopStart'|'ExitLoop',
'executionChain': [
{
'nodeName': 'string',
'index': 123,
'type': 'Iterator'|'Loop'
},
]
},
]
},
'nodeOutputEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'fields': [
{
'name': 'string',
'content': {
'document': {...}|[...]|123|123.4|'string'|True|None
},
'next': [
{
'nodeName': 'string',
'inputFieldName': 'string'
},
],
'type': 'String'|'Number'|'Boolean'|'Object'|'Array'
},
]
},
'conditionResultEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'satisfiedConditions': [
{
'conditionName': 'string'
},
]
},
'nodeFailureEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'errorCode': 'VALIDATION'|'DEPENDENCY_FAILED'|'BAD_GATEWAY'|'INTERNAL_SERVER',
'errorMessage': 'string'
},
'flowFailureEvent': {
'timestamp': datetime(2015, 1, 1),
'errorCode': 'VALIDATION'|'INTERNAL_SERVER'|'NODE_EXECUTION_FAILED',
'errorMessage': 'string'
},
'nodeActionEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'requestId': 'string',
'serviceName': 'string',
'operationName': 'string',
'operationRequest': {...}|[...]|123|123.4|'string'|True|None,
'operationResponse': {...}|[...]|123|123.4|'string'|True|None
},
'nodeDependencyEvent': {
'nodeName': 'string',
'timestamp': datetime(2015, 1, 1),
'traceElements': {
'agentTraces': [
{
'sessionId': 'string',
'trace': {
'guardrailTrace': {
'action': 'INTERVENED'|'NONE',
'traceId': 'string',
'inputAssessments': [
{
'topicPolicy': {
'topics': [
{
'name': 'string',
'type': 'DENY',
'action': 'BLOCKED'
},
]
},
'contentPolicy': {
'filters': [
{
'type': 'INSULTS'|'HATE'|'SEXUAL'|'VIOLENCE'|'MISCONDUCT'|'PROMPT_ATTACK',
'confidence': 'NONE'|'LOW'|'MEDIUM'|'HIGH',
'action': 'BLOCKED'
},
]
},
'wordPolicy': {
'customWords': [
{
'match': 'string',
'action': 'BLOCKED'
},
],
'managedWordLists': [
{
'match': 'string',
'type': 'PROFANITY',
'action': 'BLOCKED'
},
]
},
'sensitiveInformationPolicy': {
'piiEntities': [
{
'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
],
'regexes': [
{
'name': 'string',
'regex': 'string',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
]
}
},
],
'outputAssessments': [
{
'topicPolicy': {
'topics': [
{
'name': 'string',
'type': 'DENY',
'action': 'BLOCKED'
},
]
},
'contentPolicy': {
'filters': [
{
'type': 'INSULTS'|'HATE'|'SEXUAL'|'VIOLENCE'|'MISCONDUCT'|'PROMPT_ATTACK',
'confidence': 'NONE'|'LOW'|'MEDIUM'|'HIGH',
'action': 'BLOCKED'
},
]
},
'wordPolicy': {
'customWords': [
{
'match': 'string',
'action': 'BLOCKED'
},
],
'managedWordLists': [
{
'match': 'string',
'type': 'PROFANITY',
'action': 'BLOCKED'
},
]
},
'sensitiveInformationPolicy': {
'piiEntities': [
{
'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
],
'regexes': [
{
'name': 'string',
'regex': 'string',
'match': 'string',
'action': 'BLOCKED'|'ANONYMIZED'
},
]
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'preProcessingTrace': {
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'parsedResponse': {
'rationale': 'string',
'isValid': True|False
},
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'orchestrationTrace': {
'rationale': {
'traceId': 'string',
'text': 'string'
},
'invocationInput': {
'traceId': 'string',
'invocationType': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'FINISH'|'ACTION_GROUP_CODE_INTERPRETER'|'AGENT_COLLABORATOR',
'actionGroupInvocationInput': {
'actionGroupName': 'string',
'verb': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
},
'function': 'string',
'executionType': 'LAMBDA'|'RETURN_CONTROL',
'invocationId': 'string'
},
'knowledgeBaseLookupInput': {
'text': 'string',
'knowledgeBaseId': 'string'
},
'codeInterpreterInvocationInput': {
'code': 'string',
'files': [
'string',
]
},
'agentCollaboratorInvocationInput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'input': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlResults': {
'invocationId': 'string',
'returnControlInvocationResults': [
{
'apiResult': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'responseState': 'FAILURE'|'REPROMPT',
'httpStatusCode': 123,
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'agentId': 'string'
},
'functionResult': {
'actionGroup': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'function': 'string',
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'responseState': 'FAILURE'|'REPROMPT',
'agentId': 'string'
}
},
]
}
}
}
},
'observation': {
'traceId': 'string',
'type': 'ACTION_GROUP'|'AGENT_COLLABORATOR'|'KNOWLEDGE_BASE'|'FINISH'|'ASK_USER'|'REPROMPT',
'actionGroupInvocationOutput': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'agentCollaboratorInvocationOutput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'output': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlPayload': {
'invocationInputs': [
{
'apiInvocationInput': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': {
'properties': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
}
},
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
},
'functionInvocationInput': {
'actionGroup': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'function': 'string',
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
}
},
],
'invocationId': 'string'
}
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'knowledgeBaseLookupOutput': {
'retrievedReferences': [
{
'content': {
'type': 'TEXT'|'IMAGE'|'ROW',
'text': 'string',
'byteContent': 'string',
'row': [
{
'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB'|'BOOLEAN'|'DOUBLE'|'NULL'|'LONG'|'STRING'
},
]
},
'location': {
'type': 'S3'|'WEB'|'CONFLUENCE'|'SALESFORCE'|'SHAREPOINT'|'CUSTOM'|'KENDRA'|'SQL',
's3Location': {
'uri': 'string'
},
'webLocation': {
'url': 'string'
},
'confluenceLocation': {
'url': 'string'
},
'salesforceLocation': {
'url': 'string'
},
'sharePointLocation': {
'url': 'string'
},
'customDocumentLocation': {
'id': 'string'
},
'kendraDocumentLocation': {
'uri': 'string'
},
'sqlLocation': {
'query': 'string'
}
},
'metadata': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'finalResponse': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'repromptResponse': {
'text': 'string',
'source': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'PARSER'
},
'codeInterpreterInvocationOutput': {
'executionOutput': 'string',
'executionError': 'string',
'files': [
'string',
],
'executionTimeout': True|False,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'postProcessingTrace': {
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'parsedResponse': {
'text': 'string'
},
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
},
'reasoningContent': {
'reasoningText': {
'text': 'string',
'signature': 'string'
},
'redactedContent': b'bytes'
}
}
},
'routingClassifierTrace': {
'invocationInput': {
'traceId': 'string',
'invocationType': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'FINISH'|'ACTION_GROUP_CODE_INTERPRETER'|'AGENT_COLLABORATOR',
'actionGroupInvocationInput': {
'actionGroupName': 'string',
'verb': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
},
'function': 'string',
'executionType': 'LAMBDA'|'RETURN_CONTROL',
'invocationId': 'string'
},
'knowledgeBaseLookupInput': {
'text': 'string',
'knowledgeBaseId': 'string'
},
'codeInterpreterInvocationInput': {
'code': 'string',
'files': [
'string',
]
},
'agentCollaboratorInvocationInput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'input': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlResults': {
'invocationId': 'string',
'returnControlInvocationResults': [
{
'apiResult': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'responseState': 'FAILURE'|'REPROMPT',
'httpStatusCode': 123,
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'agentId': 'string'
},
'functionResult': {
'actionGroup': 'string',
'confirmationState': 'CONFIRM'|'DENY',
'function': 'string',
'responseBody': {
'string': {
'body': 'string',
'images': [
{
'format': 'png'|'jpeg'|'gif'|'webp',
'source': {
'bytes': b'bytes'
}
},
]
}
},
'responseState': 'FAILURE'|'REPROMPT',
'agentId': 'string'
}
},
]
}
}
}
},
'observation': {
'traceId': 'string',
'type': 'ACTION_GROUP'|'AGENT_COLLABORATOR'|'KNOWLEDGE_BASE'|'FINISH'|'ASK_USER'|'REPROMPT',
'actionGroupInvocationOutput': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'agentCollaboratorInvocationOutput': {
'agentCollaboratorName': 'string',
'agentCollaboratorAliasArn': 'string',
'output': {
'type': 'TEXT'|'RETURN_CONTROL',
'text': 'string',
'returnControlPayload': {
'invocationInputs': [
{
'apiInvocationInput': {
'actionGroup': 'string',
'httpMethod': 'string',
'apiPath': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'requestBody': {
'content': {
'string': {
'properties': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
]
}
}
},
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
},
'functionInvocationInput': {
'actionGroup': 'string',
'parameters': [
{
'name': 'string',
'type': 'string',
'value': 'string'
},
],
'function': 'string',
'actionInvocationType': 'RESULT'|'USER_CONFIRMATION'|'USER_CONFIRMATION_AND_RESULT',
'agentId': 'string',
'collaboratorName': 'string'
}
},
],
'invocationId': 'string'
}
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'knowledgeBaseLookupOutput': {
'retrievedReferences': [
{
'content': {
'type': 'TEXT'|'IMAGE'|'ROW',
'text': 'string',
'byteContent': 'string',
'row': [
{
'columnName': 'string',
'columnValue': 'string',
'type': 'BLOB'|'BOOLEAN'|'DOUBLE'|'NULL'|'LONG'|'STRING'
},
]
},
'location': {
'type': 'S3'|'WEB'|'CONFLUENCE'|'SALESFORCE'|'SHAREPOINT'|'CUSTOM'|'KENDRA'|'SQL',
's3Location': {
'uri': 'string'
},
'webLocation': {
'url': 'string'
},
'confluenceLocation': {
'url': 'string'
},
'salesforceLocation': {
'url': 'string'
},
'sharePointLocation': {
'url': 'string'
},
'customDocumentLocation': {
'id': 'string'
},
'kendraDocumentLocation': {
'uri': 'string'
},
'sqlLocation': {
'query': 'string'
}
},
'metadata': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
],
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'finalResponse': {
'text': 'string',
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'repromptResponse': {
'text': 'string',
'source': 'ACTION_GROUP'|'KNOWLEDGE_BASE'|'PARSER'
},
'codeInterpreterInvocationOutput': {
'executionOutput': 'string',
'executionError': 'string',
'files': [
'string',
],
'executionTimeout': True|False,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'modelInvocationInput': {
'traceId': 'string',
'text': 'string',
'type': 'PRE_PROCESSING'|'ORCHESTRATION'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'POST_PROCESSING'|'ROUTING_CLASSIFIER',
'overrideLambda': 'string',
'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
'inferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maximumLength': 123,
'stopSequences': [
'string',
]
},
'parserMode': 'DEFAULT'|'OVERRIDDEN',
'foundationModel': 'string'
},
'modelInvocationOutput': {
'traceId': 'string',
'rawResponse': {
'content': 'string'
},
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
}
},
'failureTrace': {
'traceId': 'string',
'failureReason': 'string',
'failureCode': 123,
'metadata': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'totalTimeMs': 123,
'operationTotalTimeMs': 123,
'clientRequestId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123
}
}
},
'customOrchestrationTrace': {
'traceId': 'string',
'event': {
'text': 'string'
}
}
},
'callerChain': [
{
'agentAliasArn': 'string'
},
],
'eventTime': datetime(2015, 1, 1),
'collaboratorName': 'string',
'agentId': 'string',
'agentAliasId': 'string',
'agentVersion': 'string'
},
]
}
}
},
],
'nextToken': 'string'
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents>`_