import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient"; import { InvokeFlowRequest, InvokeFlowResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link InvokeFlowCommand}. */ export interface InvokeFlowCommandInput extends InvokeFlowRequest { } /** * @public * * The output of {@link InvokeFlowCommand}. */ export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataBearer { } declare const InvokeFlowCommand_base: { new (input: InvokeFlowCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: InvokeFlowCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.

 * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { BedrockAgentRuntimeClient, InvokeFlowCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import * // const { BedrockAgentRuntimeClient, InvokeFlowCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import * // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime"; * const config = {}; // type is BedrockAgentRuntimeClientConfig * const client = new BedrockAgentRuntimeClient(config); * const input = { // InvokeFlowRequest * flowIdentifier: "STRING_VALUE", // required * flowAliasIdentifier: "STRING_VALUE", // required * inputs: [ // FlowInputs // required * { // FlowInput * nodeName: "STRING_VALUE", // required * nodeOutputName: "STRING_VALUE", * content: { // FlowInputContent Union: only one key present * document: "DOCUMENT_VALUE", * }, * nodeInputName: "STRING_VALUE", * }, * ], * enableTrace: true || false, * modelPerformanceConfiguration: { // ModelPerformanceConfiguration * performanceConfig: { // PerformanceConfiguration * latency: "standard" || "optimized", * }, * }, * executionId: "STRING_VALUE", * }; * const command = new InvokeFlowCommand(input); * const response = await client.send(command); * // { // InvokeFlowResponse * // responseStream: { // FlowResponseStream Union: only one key present * // flowOutputEvent: { // FlowOutputEvent * // nodeName: "STRING_VALUE", // required * // nodeType: "FlowInputNode" || "FlowOutputNode" || "LambdaFunctionNode" || "KnowledgeBaseNode" || "PromptNode" || "ConditionNode" || "LexNode", // required * // content: { // FlowOutputContent Union: only one key present * // document: "DOCUMENT_VALUE", * // }, * // }, * // flowCompletionEvent: { // FlowCompletionEvent * // completionReason: "SUCCESS" || "INPUT_REQUIRED", // required * // }, * // flowTraceEvent: { // FlowTraceEvent * // trace: { // FlowTrace Union: only one key present * // nodeInputTrace: { // FlowTraceNodeInputEvent * // nodeName: "STRING_VALUE", // required * // timestamp: new Date("TIMESTAMP"), // required * // fields: [ // FlowTraceNodeInputFields // required * // { // FlowTraceNodeInputField * // nodeInputName: "STRING_VALUE", // required * // content: { // FlowTraceNodeInputContent Union: only one key present * // document: "DOCUMENT_VALUE", * // }, * // source: { // FlowTraceNodeInputSource * // nodeName: "STRING_VALUE", // required * // outputFieldName: "STRING_VALUE", // required * // expression: "STRING_VALUE", // required * // }, * // type: "String" || "Number" || "Boolean" || "Object" || "Array", * // category: "LoopCondition" || "ReturnValueToLoopStart" || "ExitLoop", * // executionChain: [ // FlowTraceNodeInputExecutionChain * // { // FlowTraceNodeInputExecutionChainItem * // nodeName: "STRING_VALUE", // required * // index: Number("int"), * // type: "Iterator" || "Loop", // required * // }, * // ], * // }, * // ], * // }, * // nodeOutputTrace: { // FlowTraceNodeOutputEvent * // nodeName: "STRING_VALUE", // required * // timestamp: new Date("TIMESTAMP"), // required * // fields: [ // FlowTraceNodeOutputFields // required * // { // FlowTraceNodeOutputField * // nodeOutputName: "STRING_VALUE", // required * // content: { // FlowTraceNodeOutputContent Union: only one key present * // document: "DOCUMENT_VALUE", * // }, * // next: [ // FlowTraceNodeOutputNextList * // { // FlowTraceNodeOutputNext * // nodeName: "STRING_VALUE", // required * // inputFieldName: "STRING_VALUE", // required * // }, * // ], * // type: "String" || "Number" || "Boolean" || "Object" || "Array", * // }, * // ], * // }, * // conditionNodeResultTrace: { // FlowTraceConditionNodeResultEvent * // nodeName: "STRING_VALUE", // required * // timestamp: new Date("TIMESTAMP"), // required * // satisfiedConditions: [ // FlowTraceConditions // required * // { // FlowTraceCondition * // conditionName: "STRING_VALUE", // required * // }, * // ], * // }, * // nodeActionTrace: { // FlowTraceNodeActionEvent * // nodeName: "STRING_VALUE", // required * // timestamp: new Date("TIMESTAMP"), // required * // requestId: "STRING_VALUE", // required * // serviceName: "STRING_VALUE", // required * // operationName: "STRING_VALUE", // required * // operationRequest: "DOCUMENT_VALUE", * // operationResponse: "DOCUMENT_VALUE", * // }, * // nodeDependencyTrace: { // FlowTraceDependencyEvent * // nodeName: "STRING_VALUE", // required * // timestamp: new Date("TIMESTAMP"), // required * // traceElements: { // TraceElements Union: only one key present * // agentTraces: [ // AgentTraces * // { // TracePart * // sessionId: "STRING_VALUE", * // trace: { // Trace Union: only one key present * // guardrailTrace: { // GuardrailTrace * // action: "INTERVENED" || "NONE", * // traceId: "STRING_VALUE", * // inputAssessments: [ // GuardrailAssessmentList * // { // GuardrailAssessment * // topicPolicy: { // GuardrailTopicPolicyAssessment * // topics: [ // GuardrailTopicList * // { // GuardrailTopic * // name: "STRING_VALUE", * // type: "DENY", * // action: "BLOCKED", * // }, * // ], * // }, * // contentPolicy: { // GuardrailContentPolicyAssessment * // filters: [ // GuardrailContentFilterList * // { // GuardrailContentFilter * // type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", * // confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", * // action: "BLOCKED", * // }, * // ], * // }, * // wordPolicy: { // GuardrailWordPolicyAssessment * // customWords: [ // GuardrailCustomWordList * // { // GuardrailCustomWord * // match: "STRING_VALUE", * // action: "BLOCKED", * // }, * // ], * // managedWordLists: [ // GuardrailManagedWordList * // { // GuardrailManagedWord * // match: "STRING_VALUE", * // type: "PROFANITY", * // action: "BLOCKED", * // }, * // ], * // }, * // sensitiveInformationPolicy: { // GuardrailSensitiveInformationPolicyAssessment * // piiEntities: [ // GuardrailPiiEntityFilterList * // { // GuardrailPiiEntityFilter * // 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_VALUE", * // action: "BLOCKED" || "ANONYMIZED", * // }, * // ], * // regexes: [ // GuardrailRegexFilterList * // { // GuardrailRegexFilter * // name: "STRING_VALUE", * // regex: "STRING_VALUE", * // match: "STRING_VALUE", * // action: "BLOCKED" || "ANONYMIZED", * // }, * // ], * // }, * // }, * // ], * // outputAssessments: [ * // { * // topicPolicy: { * // topics: [ * // { * // name: "STRING_VALUE", * // 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_VALUE", * // action: "BLOCKED", * // }, * // ], * // managedWordLists: [ * // { * // match: "STRING_VALUE", * // 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_VALUE", * // action: "BLOCKED" || "ANONYMIZED", * // }, * // ], * // regexes: [ * // { * // name: "STRING_VALUE", * // regex: "STRING_VALUE", * // match: "STRING_VALUE", * // action: "BLOCKED" || "ANONYMIZED", * // }, * // ], * // }, * // }, * // ], * // metadata: { // Metadata * // startTime: new Date("TIMESTAMP"), * // endTime: new Date("TIMESTAMP"), * // totalTimeMs: Number("long"), * // operationTotalTimeMs: Number("long"), * // clientRequestId: "STRING_VALUE", * // usage: { // Usage * // inputTokens: Number("int"), * // outputTokens: Number("int"), * // }, * // }, * // }, * // preProcessingTrace: { // PreProcessingTrace Union: only one key present * // modelInvocationInput: { // ModelInvocationInput * // traceId: "STRING_VALUE", * // text: "STRING_VALUE", * // type: "PRE_PROCESSING" || "ORCHESTRATION" || "KNOWLEDGE_BASE_RESPONSE_GENERATION" || "POST_PROCESSING" || "ROUTING_CLASSIFIER", * // overrideLambda: "STRING_VALUE", * // promptCreationMode: "DEFAULT" || "OVERRIDDEN", * // inferenceConfiguration: { // InferenceConfiguration * // temperature: Number("float"), * // topP: Number("float"), * // topK: Number("int"), * // maximumLength: Number("int"), * // stopSequences: [ // StopSequences * // "STRING_VALUE", * // ], * // }, * // parserMode: "DEFAULT" || "OVERRIDDEN", * // foundationModel: "STRING_VALUE", * // }, * // modelInvocationOutput: { // PreProcessingModelInvocationOutput * // traceId: "STRING_VALUE", * // parsedResponse: { // PreProcessingParsedResponse * // rationale: "STRING_VALUE", * // isValid: true || false, * // }, * // rawResponse: { // RawResponse * // content: "STRING_VALUE", * // }, * // metadata: { * // startTime: new Date("TIMESTAMP"), * // endTime: new Date("TIMESTAMP"), * // totalTimeMs: Number("long"), * // operationTotalTimeMs: Number("long"), * // clientRequestId: "STRING_VALUE", * // usage: { * // inputTokens: Number("int"), * // outputTokens: Number("int"), * // }, * // }, * // reasoningContent: { // ReasoningContentBlock Union: only one key present * // reasoningText: { // ReasoningTextBlock * // text: "STRING_VALUE", // required * // signature: "STRING_VALUE", * // }, * // redactedContent: new Uint8Array(), * // }, * // }, * // }, * // orchestrationTrace: { // OrchestrationTrace Union: only one key present * // rationale: { // Rationale * // traceId: "STRING_VALUE", * // text: "STRING_VALUE", * // }, * // invocationInput: { // InvocationInput * // traceId: "STRING_VALUE", * // invocationType: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "FINISH" || "ACTION_GROUP_CODE_INTERPRETER" || "AGENT_COLLABORATOR", * // actionGroupInvocationInput: { // ActionGroupInvocationInput * // actionGroupName: "STRING_VALUE", * // verb: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // parameters: [ // Parameters * // { // Parameter * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // requestBody: { // RequestBody * // content: { // ContentMap * // "": [ * // { * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // }, * // }, * // function: "STRING_VALUE", * // executionType: "LAMBDA" || "RETURN_CONTROL", * // invocationId: "STRING_VALUE", * // }, * // knowledgeBaseLookupInput: { // KnowledgeBaseLookupInput * // text: "STRING_VALUE", * // knowledgeBaseId: "STRING_VALUE", * // }, * // codeInterpreterInvocationInput: { // CodeInterpreterInvocationInput * // code: "STRING_VALUE", * // files: [ // Files * // "STRING_VALUE", * // ], * // }, * // agentCollaboratorInvocationInput: { // AgentCollaboratorInvocationInput * // agentCollaboratorName: "STRING_VALUE", * // agentCollaboratorAliasArn: "STRING_VALUE", * // input: { // AgentCollaboratorInputPayload * // type: "TEXT" || "RETURN_CONTROL", * // text: "STRING_VALUE", * // returnControlResults: { // ReturnControlResults * // invocationId: "STRING_VALUE", * // returnControlInvocationResults: [ // ReturnControlInvocationResults * // { // InvocationResultMember Union: only one key present * // apiResult: { // ApiResult * // actionGroup: "STRING_VALUE", // required * // httpMethod: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // confirmationState: "CONFIRM" || "DENY", * // responseState: "FAILURE" || "REPROMPT", * // httpStatusCode: Number("int"), * // responseBody: { // ResponseBody * // "": { // ContentBody * // body: "STRING_VALUE", * // images: [ // ImageInputs * // { // ImageInput * // format: "png" || "jpeg" || "gif" || "webp", // required * // source: { // ImageInputSource Union: only one key present * // bytes: new Uint8Array(), * // }, * // }, * // ], * // }, * // }, * // agentId: "STRING_VALUE", * // }, * // functionResult: { // FunctionResult * // actionGroup: "STRING_VALUE", // required * // confirmationState: "CONFIRM" || "DENY", * // function: "STRING_VALUE", * // responseBody: { * // "": { * // body: "STRING_VALUE", * // images: [ * // { * // format: "png" || "jpeg" || "gif" || "webp", // required * // source: {// Union: only one key present * // bytes: new Uint8Array(), * // }, * // }, * // ], * // }, * // }, * // responseState: "FAILURE" || "REPROMPT", * // agentId: "STRING_VALUE", * // }, * // }, * // ], * // }, * // }, * // }, * // }, * // observation: { // Observation * // traceId: "STRING_VALUE", * // type: "ACTION_GROUP" || "AGENT_COLLABORATOR" || "KNOWLEDGE_BASE" || "FINISH" || "ASK_USER" || "REPROMPT", * // actionGroupInvocationOutput: { // ActionGroupInvocationOutput * // text: "STRING_VALUE", * // metadata: "", * // }, * // agentCollaboratorInvocationOutput: { // AgentCollaboratorInvocationOutput * // agentCollaboratorName: "STRING_VALUE", * // agentCollaboratorAliasArn: "STRING_VALUE", * // output: { // AgentCollaboratorOutputPayload * // type: "TEXT" || "RETURN_CONTROL", * // text: "STRING_VALUE", * // returnControlPayload: { // ReturnControlPayload * // invocationInputs: [ // InvocationInputs * // { // InvocationInputMember Union: only one key present * // apiInvocationInput: { // ApiInvocationInput * // actionGroup: "STRING_VALUE", // required * // httpMethod: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // parameters: [ // ApiParameters * // { // ApiParameter * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // requestBody: { // ApiRequestBody * // content: { // ApiContentMap * // "": { // PropertyParameters * // properties: [ // ParameterList * // "", * // ], * // }, * // }, * // }, * // actionInvocationType: "RESULT" || "USER_CONFIRMATION" || "USER_CONFIRMATION_AND_RESULT", * // agentId: "STRING_VALUE", * // collaboratorName: "STRING_VALUE", * // }, * // functionInvocationInput: { // FunctionInvocationInput * // actionGroup: "STRING_VALUE", // required * // parameters: [ // FunctionParameters * // { // FunctionParameter * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // function: "STRING_VALUE", * // actionInvocationType: "RESULT" || "USER_CONFIRMATION" || "USER_CONFIRMATION_AND_RESULT", * // agentId: "STRING_VALUE", * // collaboratorName: "STRING_VALUE", * // }, * // }, * // ], * // invocationId: "STRING_VALUE", * // }, * // }, * // metadata: "", * // }, * // knowledgeBaseLookupOutput: { // KnowledgeBaseLookupOutput * // retrievedReferences: [ // RetrievedReferences * // { // RetrievedReference * // content: { // RetrievalResultContent * // type: "TEXT" || "IMAGE" || "ROW", * // text: "STRING_VALUE", * // byteContent: "STRING_VALUE", * // row: [ // RetrievalResultContentRow * // { // RetrievalResultContentColumn * // columnName: "STRING_VALUE", * // columnValue: "STRING_VALUE", * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING", * // }, * // ], * // }, * // location: { // RetrievalResultLocation * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required * // s3Location: { // RetrievalResultS3Location * // uri: "STRING_VALUE", * // }, * // webLocation: { // RetrievalResultWebLocation * // url: "STRING_VALUE", * // }, * // confluenceLocation: { // RetrievalResultConfluenceLocation * // url: "STRING_VALUE", * // }, * // salesforceLocation: { // RetrievalResultSalesforceLocation * // url: "STRING_VALUE", * // }, * // sharePointLocation: { // RetrievalResultSharePointLocation * // url: "STRING_VALUE", * // }, * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation * // id: "STRING_VALUE", * // }, * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation * // uri: "STRING_VALUE", * // }, * // sqlLocation: { // RetrievalResultSqlLocation * // query: "STRING_VALUE", * // }, * // }, * // metadata: { // RetrievalResultMetadata * // "": "DOCUMENT_VALUE", * // }, * // }, * // ], * // metadata: "", * // }, * // finalResponse: { // FinalResponse * // text: "STRING_VALUE", * // metadata: "", * // }, * // repromptResponse: { // RepromptResponse * // text: "STRING_VALUE", * // source: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "PARSER", * // }, * // codeInterpreterInvocationOutput: { // CodeInterpreterInvocationOutput * // executionOutput: "STRING_VALUE", * // executionError: "STRING_VALUE", * // files: [ * // "STRING_VALUE", * // ], * // executionTimeout: true || false, * // metadata: "", * // }, * // }, * // modelInvocationInput: { * // traceId: "STRING_VALUE", * // text: "STRING_VALUE", * // type: "PRE_PROCESSING" || "ORCHESTRATION" || "KNOWLEDGE_BASE_RESPONSE_GENERATION" || "POST_PROCESSING" || "ROUTING_CLASSIFIER", * // overrideLambda: "STRING_VALUE", * // promptCreationMode: "DEFAULT" || "OVERRIDDEN", * // inferenceConfiguration: { * // temperature: Number("float"), * // topP: Number("float"), * // topK: Number("int"), * // maximumLength: Number("int"), * // stopSequences: [ * // "STRING_VALUE", * // ], * // }, * // parserMode: "DEFAULT" || "OVERRIDDEN", * // foundationModel: "STRING_VALUE", * // }, * // modelInvocationOutput: { // OrchestrationModelInvocationOutput * // traceId: "STRING_VALUE", * // rawResponse: { * // content: "STRING_VALUE", * // }, * // metadata: "", * // reasoningContent: {// Union: only one key present * // reasoningText: { * // text: "STRING_VALUE", // required * // signature: "STRING_VALUE", * // }, * // redactedContent: new Uint8Array(), * // }, * // }, * // }, * // postProcessingTrace: { // PostProcessingTrace Union: only one key present * // modelInvocationInput: { * // traceId: "STRING_VALUE", * // text: "STRING_VALUE", * // type: "PRE_PROCESSING" || "ORCHESTRATION" || "KNOWLEDGE_BASE_RESPONSE_GENERATION" || "POST_PROCESSING" || "ROUTING_CLASSIFIER", * // overrideLambda: "STRING_VALUE", * // promptCreationMode: "DEFAULT" || "OVERRIDDEN", * // inferenceConfiguration: { * // temperature: Number("float"), * // topP: Number("float"), * // topK: Number("int"), * // maximumLength: Number("int"), * // stopSequences: [ * // "STRING_VALUE", * // ], * // }, * // parserMode: "DEFAULT" || "OVERRIDDEN", * // foundationModel: "STRING_VALUE", * // }, * // modelInvocationOutput: { // PostProcessingModelInvocationOutput * // traceId: "STRING_VALUE", * // parsedResponse: { // PostProcessingParsedResponse * // text: "STRING_VALUE", * // }, * // rawResponse: { * // content: "STRING_VALUE", * // }, * // metadata: "", * // reasoningContent: {// Union: only one key present * // reasoningText: { * // text: "STRING_VALUE", // required * // signature: "STRING_VALUE", * // }, * // redactedContent: new Uint8Array(), * // }, * // }, * // }, * // routingClassifierTrace: { // RoutingClassifierTrace Union: only one key present * // invocationInput: { * // traceId: "STRING_VALUE", * // invocationType: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "FINISH" || "ACTION_GROUP_CODE_INTERPRETER" || "AGENT_COLLABORATOR", * // actionGroupInvocationInput: { * // actionGroupName: "STRING_VALUE", * // verb: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // parameters: [ * // "", * // ], * // requestBody: { * // content: { * // "": [ * // "", * // ], * // }, * // }, * // function: "STRING_VALUE", * // executionType: "LAMBDA" || "RETURN_CONTROL", * // invocationId: "STRING_VALUE", * // }, * // knowledgeBaseLookupInput: { * // text: "STRING_VALUE", * // knowledgeBaseId: "STRING_VALUE", * // }, * // codeInterpreterInvocationInput: { * // code: "STRING_VALUE", * // files: [ * // "STRING_VALUE", * // ], * // }, * // agentCollaboratorInvocationInput: { * // agentCollaboratorName: "STRING_VALUE", * // agentCollaboratorAliasArn: "STRING_VALUE", * // input: { * // type: "TEXT" || "RETURN_CONTROL", * // text: "STRING_VALUE", * // returnControlResults: { * // invocationId: "STRING_VALUE", * // returnControlInvocationResults: [ * // {// Union: only one key present * // apiResult: { * // actionGroup: "STRING_VALUE", // required * // httpMethod: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // confirmationState: "CONFIRM" || "DENY", * // responseState: "FAILURE" || "REPROMPT", * // httpStatusCode: Number("int"), * // responseBody: { * // "": { * // body: "STRING_VALUE", * // images: [ * // { * // format: "png" || "jpeg" || "gif" || "webp", // required * // source: {// Union: only one key present * // bytes: new Uint8Array(), * // }, * // }, * // ], * // }, * // }, * // agentId: "STRING_VALUE", * // }, * // functionResult: { * // actionGroup: "STRING_VALUE", // required * // confirmationState: "CONFIRM" || "DENY", * // function: "STRING_VALUE", * // responseBody: { * // "": { * // body: "STRING_VALUE", * // images: [ * // { * // format: "png" || "jpeg" || "gif" || "webp", // required * // source: {// Union: only one key present * // bytes: new Uint8Array(), * // }, * // }, * // ], * // }, * // }, * // responseState: "FAILURE" || "REPROMPT", * // agentId: "STRING_VALUE", * // }, * // }, * // ], * // }, * // }, * // }, * // }, * // observation: { * // traceId: "STRING_VALUE", * // type: "ACTION_GROUP" || "AGENT_COLLABORATOR" || "KNOWLEDGE_BASE" || "FINISH" || "ASK_USER" || "REPROMPT", * // actionGroupInvocationOutput: { * // text: "STRING_VALUE", * // metadata: "", * // }, * // agentCollaboratorInvocationOutput: { * // agentCollaboratorName: "STRING_VALUE", * // agentCollaboratorAliasArn: "STRING_VALUE", * // output: { * // type: "TEXT" || "RETURN_CONTROL", * // text: "STRING_VALUE", * // returnControlPayload: { * // invocationInputs: [ * // {// Union: only one key present * // apiInvocationInput: { * // actionGroup: "STRING_VALUE", // required * // httpMethod: "STRING_VALUE", * // apiPath: "STRING_VALUE", * // parameters: [ * // { * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // requestBody: { * // content: { * // "": { * // properties: [ * // "", * // ], * // }, * // }, * // }, * // actionInvocationType: "RESULT" || "USER_CONFIRMATION" || "USER_CONFIRMATION_AND_RESULT", * // agentId: "STRING_VALUE", * // collaboratorName: "STRING_VALUE", * // }, * // functionInvocationInput: { * // actionGroup: "STRING_VALUE", // required * // parameters: [ * // { * // name: "STRING_VALUE", * // type: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // function: "STRING_VALUE", * // actionInvocationType: "RESULT" || "USER_CONFIRMATION" || "USER_CONFIRMATION_AND_RESULT", * // agentId: "STRING_VALUE", * // collaboratorName: "STRING_VALUE", * // }, * // }, * // ], * // invocationId: "STRING_VALUE", * // }, * // }, * // metadata: "", * // }, * // knowledgeBaseLookupOutput: { * // retrievedReferences: [ * // { * // content: { * // type: "TEXT" || "IMAGE" || "ROW", * // text: "STRING_VALUE", * // byteContent: "STRING_VALUE", * // row: [ * // { * // columnName: "STRING_VALUE", * // columnValue: "STRING_VALUE", * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING", * // }, * // ], * // }, * // location: { * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required * // s3Location: { * // uri: "STRING_VALUE", * // }, * // webLocation: { * // url: "STRING_VALUE", * // }, * // confluenceLocation: { * // url: "STRING_VALUE", * // }, * // salesforceLocation: { * // url: "STRING_VALUE", * // }, * // sharePointLocation: { * // url: "STRING_VALUE", * // }, * // customDocumentLocation: { * // id: "STRING_VALUE", * // }, * // kendraDocumentLocation: { * // uri: "STRING_VALUE", * // }, * // sqlLocation: { * // query: "STRING_VALUE", * // }, * // }, * // metadata: { * // "": "DOCUMENT_VALUE", * // }, * // }, * // ], * // metadata: "", * // }, * // finalResponse: { * // text: "STRING_VALUE", * // metadata: "", * // }, * // repromptResponse: { * // text: "STRING_VALUE", * // source: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "PARSER", * // }, * // codeInterpreterInvocationOutput: { * // executionOutput: "STRING_VALUE", * // executionError: "STRING_VALUE", * // files: [ * // "STRING_VALUE", * // ], * // executionTimeout: true || false, * // metadata: "", * // }, * // }, * // modelInvocationInput: { * // traceId: "STRING_VALUE", * // text: "STRING_VALUE", * // type: "PRE_PROCESSING" || "ORCHESTRATION" || "KNOWLEDGE_BASE_RESPONSE_GENERATION" || "POST_PROCESSING" || "ROUTING_CLASSIFIER", * // overrideLambda: "STRING_VALUE", * // promptCreationMode: "DEFAULT" || "OVERRIDDEN", * // inferenceConfiguration: { * // temperature: Number("float"), * // topP: Number("float"), * // topK: Number("int"), * // maximumLength: Number("int"), * // stopSequences: [ * // "STRING_VALUE", * // ], * // }, * // parserMode: "DEFAULT" || "OVERRIDDEN", * // foundationModel: "STRING_VALUE", * // }, * // modelInvocationOutput: { // RoutingClassifierModelInvocationOutput * // traceId: "STRING_VALUE", * // rawResponse: { * // content: "STRING_VALUE", * // }, * // metadata: "", * // }, * // }, * // failureTrace: { // FailureTrace * // traceId: "STRING_VALUE", * // failureReason: "STRING_VALUE", * // failureCode: Number("int"), * // metadata: "", * // }, * // customOrchestrationTrace: { // CustomOrchestrationTrace * // traceId: "STRING_VALUE", * // event: { // CustomOrchestrationTraceEvent * // text: "STRING_VALUE", * // }, * // }, * // }, * // callerChain: [ // CallerChain * // { // Caller Union: only one key present * // agentAliasArn: "STRING_VALUE", * // }, * // ], * // eventTime: new Date("TIMESTAMP"), * // collaboratorName: "STRING_VALUE", * // agentId: "STRING_VALUE", * // agentAliasId: "STRING_VALUE", * // agentVersion: "STRING_VALUE", * // }, * // ], * // }, * // }, * // }, * // }, * // internalServerException: { // InternalServerException * // message: "STRING_VALUE", * // reason: "STRING_VALUE", * // }, * // validationException: { // ValidationException * // message: "STRING_VALUE", * // }, * // resourceNotFoundException: { // ResourceNotFoundException * // message: "STRING_VALUE", * // }, * // serviceQuotaExceededException: { // ServiceQuotaExceededException * // message: "STRING_VALUE", * // }, * // throttlingException: { // ThrottlingException * // message: "STRING_VALUE", * // }, * // accessDeniedException: { // AccessDeniedException * // message: "STRING_VALUE", * // }, * // conflictException: { // ConflictException * // message: "STRING_VALUE", * // }, * // dependencyFailedException: { // DependencyFailedException * // message: "STRING_VALUE", * // resourceName: "STRING_VALUE", * // }, * // badGatewayException: { // BadGatewayException * // message: "STRING_VALUE", * // resourceName: "STRING_VALUE", * // }, * // flowMultiTurnInputRequestEvent: { // FlowMultiTurnInputRequestEvent * // nodeName: "STRING_VALUE", // required * // nodeType: "FlowInputNode" || "FlowOutputNode" || "LambdaFunctionNode" || "KnowledgeBaseNode" || "PromptNode" || "ConditionNode" || "LexNode", // required * // content: { // FlowMultiTurnInputContent Union: only one key present * // document: "DOCUMENT_VALUE", * // }, * // }, * // }, * // executionId: "STRING_VALUE", * // }; * * ``` * * @param InvokeFlowCommandInput - {@link InvokeFlowCommandInput} * @returns {@link InvokeFlowCommandOutput} * @see {@link InvokeFlowCommandInput} for command's `input` shape. * @see {@link InvokeFlowCommandOutput} for command's `response` shape. * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

The request is denied because of missing access permissions. Check your permissions and retry your request.

* * @throws {@link BadGatewayException} (server fault) *

There was an issue with a dependency due to a server issue. Retry your request.

* * @throws {@link ConflictException} (client fault) *

There was a conflict performing an operation. Resolve the conflict and retry your request.

* * @throws {@link DependencyFailedException} (client fault) *

There was an issue with a dependency. Check the resource configurations and retry the request.

* * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentRuntimeServiceException} *

Base exception class for all service exceptions from BedrockAgentRuntime service.

* * * @public */ export declare class InvokeFlowCommand extends InvokeFlowCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: InvokeFlowRequest; output: InvokeFlowResponse; }; sdk: { input: InvokeFlowCommandInput; output: InvokeFlowCommandOutput; }; }; }