Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs
", "idempotent":true }, "CreateSession":{ "name":"CreateSession", "http":{ "method":"PUT", "requestUri":"/sessions/", "responseCode":201 }, "input":{"shape":"CreateSessionRequest"}, "output":{"shape":"CreateSessionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.
You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation.
Related APIs:
", "idempotent":true }, "DeleteAgentMemory":{ "name":"DeleteAgentMemory", "http":{ "method":"DELETE", "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/memories", "responseCode":202 }, "input":{"shape":"DeleteAgentMemoryRequest"}, "output":{"shape":"DeleteAgentMemoryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Deletes memory from the specified memory identifier.
", "idempotent":true }, "DeleteSession":{ "name":"DeleteSession", "http":{ "method":"DELETE", "requestUri":"/sessions/{sessionIdentifier}/", "responseCode":200 }, "input":{"shape":"DeleteSessionRequest"}, "output":{"shape":"DeleteSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "idempotent":true }, "GenerateQuery":{ "name":"GenerateQuery", "http":{ "method":"POST", "requestUri":"/generateQuery", "responseCode":200 }, "input":{"shape":"GenerateQueryRequest"}, "output":{"shape":"GenerateQueryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
" }, "GetAgentMemory":{ "name":"GetAgentMemory", "http":{ "method":"GET", "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/memories", "responseCode":200 }, "input":{"shape":"GetAgentMemoryRequest"}, "output":{"shape":"GetAgentMemoryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Gets the sessions stored in the memory of the agent.
" }, "GetExecutionFlowSnapshot":{ "name":"GetExecutionFlowSnapshot", "http":{ "method":"GET", "requestUri":"/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/flowsnapshot", "responseCode":200 }, "input":{"shape":"GetExecutionFlowSnapshotRequest"}, "output":{"shape":"GetExecutionFlowSnapshotResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
" }, "GetInvocationStep":{ "name":"GetInvocationStep", "http":{ "method":"POST", "requestUri":"/sessions/{sessionIdentifier}/invocationSteps/{invocationStepId}", "responseCode":200 }, "input":{"shape":"GetInvocationStepRequest"}, "output":{"shape":"GetInvocationStepResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "GetSession":{ "name":"GetSession", "http":{ "method":"GET", "requestUri":"/sessions/{sessionIdentifier}/", "responseCode":200 }, "input":{"shape":"GetSessionRequest"}, "output":{"shape":"GetSessionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "InvokeAgent":{ "name":"InvokeAgent", "http":{ "method":"POST", "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text", "responseCode":200 }, "input":{"shape":"InvokeAgentRequest"}, "output":{"shape":"InvokeAgentResponse"}, "errors":[ {"shape":"ModelNotReadyException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
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.
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
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.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "ListInvocations":{ "name":"ListInvocations", "http":{ "method":"POST", "requestUri":"/sessions/{sessionIdentifier}/invocations/", "responseCode":200 }, "input":{"shape":"ListInvocationsRequest"}, "output":{"shape":"ListInvocationsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "ListSessions":{ "name":"ListSessions", "http":{ "method":"POST", "requestUri":"/sessions/", "responseCode":200 }, "input":{"shape":"ListSessionsRequest"}, "output":{"shape":"ListSessionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"List all the tags for the resource you specify.
" }, "OptimizePrompt":{ "name":"OptimizePrompt", "http":{ "method":"POST", "requestUri":"/optimize-prompt", "responseCode":200 }, "input":{"shape":"OptimizePromptRequest"}, "output":{"shape":"OptimizePromptResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
" }, "PutInvocationStep":{ "name":"PutInvocationStep", "http":{ "method":"PUT", "requestUri":"/sessions/{sessionIdentifier}/invocationSteps/", "responseCode":201 }, "input":{"shape":"PutInvocationStepRequest"}, "output":{"shape":"PutInvocationStepResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs:
", "idempotent":true }, "Rerank":{ "name":"Rerank", "http":{ "method":"POST", "requestUri":"/rerank", "responseCode":200 }, "input":{"shape":"RerankRequest"}, "output":{"shape":"RerankResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
" }, "Retrieve":{ "name":"Retrieve", "http":{ "method":"POST", "requestUri":"/knowledgebases/{knowledgeBaseId}/retrieve", "responseCode":200 }, "input":{"shape":"RetrieveRequest"}, "output":{"shape":"RetrieveResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Queries a knowledge base and retrieves information from it.
" }, "RetrieveAndGenerate":{ "name":"RetrieveAndGenerate", "http":{ "method":"POST", "requestUri":"/retrieveAndGenerate", "responseCode":200 }, "input":{"shape":"RetrieveAndGenerateRequest"}, "output":{"shape":"RetrieveAndGenerateResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.
" }, "RetrieveAndGenerateStream":{ "name":"RetrieveAndGenerateStream", "http":{ "method":"POST", "requestUri":"/retrieveAndGenerateStream", "responseCode":200 }, "input":{"shape":"RetrieveAndGenerateStreamRequest"}, "output":{"shape":"RetrieveAndGenerateStreamResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, {"shape":"BadGatewayException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Remove tags from a resource.
", "idempotent":true }, "UpdateSession":{ "name":"UpdateSession", "http":{ "method":"PUT", "requestUri":"/sessions/{sessionIdentifier}/", "responseCode":200 }, "input":{"shape":"UpdateSessionRequest"}, "output":{"shape":"UpdateSessionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "idempotent":true } }, "shapes":{ "APISchema":{ "type":"structure", "members":{ "payload":{ "shape":"Payload", "documentation":"The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" }, "s3":{ "shape":"S3Identifier", "documentation":"Contains details about the S3 object containing the OpenAPI schema for the action group.
" } }, "documentation":"Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
", "union":true }, "AWSResourceARN":{ "type":"string", "max":2048, "min":0, "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ActionGroupExecutor":{ "type":"structure", "members":{ "customControl":{ "shape":"CustomControlMethod", "documentation":" To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "documentation":"Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
", "union":true }, "ActionGroupInvocationInput":{ "type":"structure", "members":{ "actionGroupName":{ "shape":"ActionGroupName", "documentation":"The name of the action group.
" }, "apiPath":{ "shape":"ApiPath", "documentation":"The path to the API to call, based off the action group.
" }, "executionType":{ "shape":"ExecutionType", "documentation":"How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" }, "function":{ "shape":"Function", "documentation":"The function in the action group to call.
" }, "invocationId":{ "shape":"String", "documentation":"The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.
The parameters in the Lambda input event.
" }, "requestBody":{ "shape":"RequestBody", "documentation":"The parameters in the request body for the Lambda input event.
" }, "verb":{ "shape":"Verb", "documentation":"The API method being used, based off the action group.
" } }, "documentation":"Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
" }, "ActionGroupInvocationOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the action group output.
" }, "text":{ "shape":"ActionGroupOutputString", "documentation":"The JSON-formatted string returned by the API invoked by the action group.
" } }, "documentation":"Contains the JSON-formatted string returned by the API invoked by the action group.
" }, "ActionGroupName":{ "type":"string", "sensitive":true }, "ActionGroupOutputString":{ "type":"string", "sensitive":true }, "ActionGroupSignature":{ "type":"string", "enum":[ "AMAZON.UserInput", "AMAZON.CodeInterpreter", "ANTHROPIC.Computer", "ANTHROPIC.Bash", "ANTHROPIC.TextEditor" ] }, "ActionGroupSignatureParams":{ "type":"map", "key":{"shape":"ActionGroupSignatureParamsKeyString"}, "value":{"shape":"ActionGroupSignatureParamsValueString"} }, "ActionGroupSignatureParamsKeyString":{ "type":"string", "max":100, "min":0 }, "ActionGroupSignatureParamsValueString":{ "type":"string", "max":100, "min":0 }, "ActionInvocationType":{ "type":"string", "enum":[ "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT" ] }, "AdditionalModelRequestFields":{ "type":"map", "key":{"shape":"AdditionalModelRequestFieldsKey"}, "value":{"shape":"AdditionalModelRequestFieldsValue"} }, "AdditionalModelRequestFieldsKey":{ "type":"string", "max":100, "min":1 }, "AdditionalModelRequestFieldsValue":{ "type":"structure", "members":{}, "document":true }, "AgentActionGroup":{ "type":"structure", "required":["actionGroupName"], "members":{ "actionGroupExecutor":{ "shape":"ActionGroupExecutor", "documentation":"The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" }, "actionGroupName":{ "shape":"ResourceName", "documentation":"The name of the action group.
" }, "apiSchema":{ "shape":"APISchema", "documentation":"Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" }, "description":{ "shape":"ResourceDescription", "documentation":"A description of the action group.
" }, "functionSchema":{ "shape":"FunctionSchema", "documentation":"Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" }, "parentActionGroupSignature":{ "shape":"ActionGroupSignature", "documentation":"Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains details of the inline agent's action group.
" }, "AgentActionGroups":{ "type":"list", "member":{"shape":"AgentActionGroup"} }, "AgentAliasArn":{ "type":"string", "max":2048, "min":0, "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" }, "AgentAliasId":{ "type":"string", "max":10, "min":0, "pattern":"^[0-9a-zA-Z]+$" }, "AgentCollaboration":{ "type":"string", "enum":[ "SUPERVISOR", "SUPERVISOR_ROUTER", "DISABLED" ] }, "AgentCollaboratorInputPayload":{ "type":"structure", "members":{ "returnControlResults":{ "shape":"ReturnControlResults", "documentation":"An action invocation result.
" }, "text":{ "shape":"AgentCollaboratorPayloadString", "documentation":"Input text.
" }, "type":{ "shape":"PayloadType", "documentation":"The input type.
" } }, "documentation":"Input for an agent collaborator. The input can be text or an action invocation result.
" }, "AgentCollaboratorInvocationInput":{ "type":"structure", "members":{ "agentCollaboratorAliasArn":{ "shape":"AgentAliasArn", "documentation":"The collaborator's alias ARN.
" }, "agentCollaboratorName":{ "shape":"String", "documentation":"The collaborator's name.
" }, "input":{ "shape":"AgentCollaboratorInputPayload", "documentation":"Text or action invocation result input for the collaborator.
" } }, "documentation":"An agent collaborator invocation input.
" }, "AgentCollaboratorInvocationOutput":{ "type":"structure", "members":{ "agentCollaboratorAliasArn":{ "shape":"AgentAliasArn", "documentation":"The output's agent collaborator alias ARN.
" }, "agentCollaboratorName":{ "shape":"String", "documentation":"The output's agent collaborator name.
" }, "metadata":{ "shape":"Metadata", "documentation":"Contains information about the output from the agent collaborator.
" }, "output":{ "shape":"AgentCollaboratorOutputPayload", "documentation":"The output's output.
" } }, "documentation":"Output from an agent collaborator.
" }, "AgentCollaboratorOutputPayload":{ "type":"structure", "members":{ "returnControlPayload":{ "shape":"ReturnControlPayload", "documentation":"An action invocation result.
" }, "text":{ "shape":"AgentCollaboratorPayloadString", "documentation":"Text output.
" }, "type":{ "shape":"PayloadType", "documentation":"The type of output.
" } }, "documentation":"Output from an agent collaborator. The output can be text or an action invocation result.
" }, "AgentCollaboratorPayloadString":{ "type":"string", "sensitive":true }, "AgentId":{ "type":"string", "max":10, "min":0, "pattern":"^[0-9a-zA-Z]+$" }, "AgentTraces":{ "type":"list", "member":{"shape":"TracePart"} }, "AgentVersion":{ "type":"string", "max":5, "min":1, "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" }, "AnalyzePromptEvent":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"A message describing the analysis of the prompt.
" } }, "documentation":"An event in which the prompt was analyzed in preparation for optimization.
", "event":true, "sensitive":true }, "ApiContentMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"PropertyParameters"} }, "ApiInvocationInput":{ "type":"structure", "required":["actionGroup"], "members":{ "actionGroup":{ "shape":"String", "documentation":"The action group that the API operation belongs to.
" }, "actionInvocationType":{ "shape":"ActionInvocationType", "documentation":"Contains information about the API operation to invoke.
" }, "agentId":{ "shape":"String", "documentation":"The agent's ID.
" }, "apiPath":{ "shape":"ApiPath", "documentation":"The path to the API operation.
" }, "collaboratorName":{ "shape":"Name", "documentation":"The agent collaborator's name.
" }, "httpMethod":{ "shape":"String", "documentation":"The HTTP method of the API operation.
" }, "parameters":{ "shape":"ApiParameters", "documentation":"The parameters to provide for the API request, as the agent elicited from the user.
" }, "requestBody":{ "shape":"ApiRequestBody", "documentation":"The request body to provide for the API request, as the agent elicited from the user.
" } }, "documentation":"Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The name of the parameter.
" }, "type":{ "shape":"String", "documentation":"The data type for the parameter.
" }, "value":{ "shape":"String", "documentation":"The value of the parameter.
" } }, "documentation":"Information about a parameter to provide to the API request.
This data type is used in the following API operations:
" }, "ApiParameters":{ "type":"list", "member":{"shape":"ApiParameter"} }, "ApiPath":{ "type":"string", "sensitive":true }, "ApiRequestBody":{ "type":"structure", "members":{ "content":{ "shape":"ApiContentMap", "documentation":"The content of the request body. The key of the object in this field is a media type defining the format of the request body.
" } }, "documentation":"The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
" }, "ApiResult":{ "type":"structure", "required":["actionGroup"], "members":{ "actionGroup":{ "shape":"String", "documentation":"The action group that the API operation belongs to.
" }, "agentId":{ "shape":"String", "documentation":"The agent's ID.
" }, "apiPath":{ "shape":"ApiPath", "documentation":"The path to the API operation.
" }, "confirmationState":{ "shape":"ConfirmationState", "documentation":"Controls the API operations or functions to invoke based on the user confirmation.
" }, "httpMethod":{ "shape":"String", "documentation":"The HTTP method for the API operation.
" }, "httpStatusCode":{ "shape":"Integer", "documentation":"http status code from API execution response (for example: 200, 400, 500).
" }, "responseBody":{ "shape":"ResponseBody", "documentation":"The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" } }, "documentation":"Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
A list of citations and related information for a part of an agent response.
" } }, "documentation":"Contains citations for a part of an agent response.
" }, "AudioSegment":{ "type":"structure", "required":["s3Uri"], "members":{ "s3Uri":{ "shape":"AudioSegmentS3UriString", "documentation":"The S3 URI where this specific audio segment is stored in the multimodal storage destination.
" }, "transcription":{ "shape":"String", "documentation":"The text transcription of the audio segment content.
" } }, "documentation":"Contains information about an audio segment retrieved from a knowledge base, including its location and transcription.
This data type is used in the following API operations:
Retrieve response – in the audio field
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" } }, "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
", "error":{"httpStatusCode":502}, "exception":true, "fault":true }, "BasePromptTemplate":{ "type":"string", "max":100000, "min":1, "sensitive":true }, "BedrockModelArn":{ "type":"string", "max":2048, "min":1, "pattern":"^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" }, "BedrockModelConfigurations":{ "type":"structure", "members":{ "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The performance configuration for the model.
" } }, "documentation":"Settings for a model called with InvokeAgent.
" }, "BedrockRerankingConfiguration":{ "type":"structure", "required":["modelConfiguration"], "members":{ "modelConfiguration":{ "shape":"BedrockRerankingModelConfiguration", "documentation":"Contains configurations for a reranker model.
" }, "numberOfResults":{ "shape":"BedrockRerankingConfigurationNumberOfResultsInteger", "documentation":"The number of results to return after reranking.
" } }, "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" }, "BedrockRerankingConfigurationNumberOfResultsInteger":{ "type":"integer", "box":true, "max":1000, "min":1 }, "BedrockRerankingModelArn":{ "type":"string", "max":2048, "min":1, "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" }, "BedrockRerankingModelConfiguration":{ "type":"structure", "required":["modelArn"], "members":{ "additionalModelRequestFields":{ "shape":"AdditionalModelRequestFields", "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" }, "modelArn":{ "shape":"BedrockModelArn", "documentation":"The ARN of the reranker model.
" } }, "documentation":"Contains configurations for a reranker model.
" }, "BedrockSessionContentBlock":{ "type":"structure", "members":{ "image":{ "shape":"ImageBlock", "documentation":"The image in the invocation step.
" }, "text":{ "shape":"BedrockSessionContentBlockTextString", "documentation":"The text in the invocation step.
" } }, "documentation":"A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.
For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "sensitive":true, "union":true }, "BedrockSessionContentBlockTextString":{ "type":"string", "min":1 }, "BedrockSessionContentBlocks":{ "type":"list", "member":{"shape":"BedrockSessionContentBlock"}, "min":1 }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", "box":true }, "ByteContentBlob":{ "type":"blob", "max":10485760, "min":1, "sensitive":true }, "ByteContentDoc":{ "type":"structure", "required":[ "contentType", "data", "identifier" ], "members":{ "contentType":{ "shape":"ContentType", "documentation":"The MIME type of the document contained in the wrapper object.
" }, "data":{ "shape":"ByteContentBlob", "documentation":"The byte value of the file to upload, encoded as a Base-64 string.
" }, "identifier":{ "shape":"Identifier", "documentation":"The file name of the document contained in the wrapper object.
" } }, "documentation":"This property contains the document to chat with, along with its attributes.
" }, "ByteContentFile":{ "type":"structure", "required":[ "data", "mediaType" ], "members":{ "data":{ "shape":"ByteContentBlob", "documentation":"The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
" }, "mediaType":{ "shape":"MimeType", "documentation":"The MIME type of data contained in the file used for chat.
" } }, "documentation":"The property contains the file to chat with, along with its attributes.
" }, "Caller":{ "type":"structure", "members":{ "agentAliasArn":{ "shape":"AgentAliasArn", "documentation":"The caller's agent alias ARN.
" } }, "documentation":"Details about a caller.
", "union":true }, "CallerChain":{ "type":"list", "member":{"shape":"Caller"} }, "Citation":{ "type":"structure", "members":{ "generatedResponsePart":{ "shape":"GeneratedResponsePart", "documentation":"Contains the generated response and metadata
" }, "retrievedReferences":{ "shape":"RetrievedReferences", "documentation":"Contains metadata about the sources cited for the generated response.
" } }, "documentation":"An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
The citation.
", "deprecated":true, "deprecatedMessage":"Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event." }, "generatedResponsePart":{ "shape":"GeneratedResponsePart", "documentation":"The generated response to the citation event.
" }, "retrievedReferences":{ "shape":"RetrievedReferences", "documentation":"The retrieved references of the citation event.
" } }, "documentation":"A citation event.
", "event":true }, "Citations":{ "type":"list", "member":{"shape":"Citation"} }, "CodeInterpreterInvocationInput":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"The code for the code interpreter to use.
" }, "files":{ "shape":"Files", "documentation":"Files that are uploaded for code interpreter to use.
" } }, "documentation":"Contains information about the code interpreter being invoked.
" }, "CodeInterpreterInvocationOutput":{ "type":"structure", "members":{ "executionError":{ "shape":"String", "documentation":"Contains the error returned from code execution.
" }, "executionOutput":{ "shape":"String", "documentation":"Contains the successful output returned from code execution
" }, "executionTimeout":{ "shape":"Boolean", "documentation":"Indicates if the execution of the code timed out.
" }, "files":{ "shape":"Files", "documentation":"Contains output files, if generated by code execution.
" }, "metadata":{ "shape":"Metadata", "documentation":"Contains information about the output from the code interpreter.
" } }, "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" }, "CollaborationInstruction":{ "type":"string", "max":4000, "min":1, "sensitive":true }, "Collaborator":{ "type":"structure", "required":[ "foundationModel", "instruction" ], "members":{ "actionGroups":{ "shape":"AgentActionGroups", "documentation":"List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" }, "agentCollaboration":{ "shape":"AgentCollaboration", "documentation":"Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" }, "agentName":{ "shape":"Name", "documentation":" Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
Settings of the collaborator agent.
" }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
" }, "foundationModel":{ "shape":"ModelIdentifier", "documentation":"The foundation model used by the inline collaborator agent.
" }, "guardrailConfiguration":{ "shape":"GuardrailConfigurationWithArn", "documentation":"Details of the guardwrail associated with the inline collaborator.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", "documentation":"The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" }, "instruction":{ "shape":"Instruction", "documentation":"Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
" }, "knowledgeBases":{ "shape":"KnowledgeBases", "documentation":"Knowledge base associated with the inline collaborator agent.
" }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
" } }, "documentation":"List of inline collaborators.
" }, "CollaboratorConfiguration":{ "type":"structure", "required":[ "collaboratorInstruction", "collaboratorName" ], "members":{ "agentAliasArn":{ "shape":"AgentAliasArn", "documentation":"The Amazon Resource Name (ARN) of the inline collaborator agent.
" }, "collaboratorInstruction":{ "shape":"CollaborationInstruction", "documentation":"Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
" }, "collaboratorName":{ "shape":"Name", "documentation":" Name of the inline collaborator agent which must be the same name as specified for agentName.
A relay conversation history for the inline collaborator agent.
" } }, "documentation":"Settings of an inline collaborator agent.
" }, "CollaboratorConfigurations":{ "type":"list", "member":{"shape":"CollaboratorConfiguration"} }, "Collaborators":{ "type":"list", "member":{"shape":"Collaborator"} }, "ConditionResultEvent":{ "type":"structure", "required":[ "nodeName", "satisfiedConditions", "timestamp" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the condition node that evaluated the conditions.
" }, "satisfiedConditions":{ "shape":"SatisfiedConditions", "documentation":"A list of conditions that were satisfied during the evaluation.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the condition evaluation occurred.
" } }, "documentation":"Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
There was a conflict performing an operation. Resolve the conflict and retry your request.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ContentBlock":{ "type":"structure", "members":{ "text":{ "shape":"String", "documentation":"The block's text.
" } }, "documentation":"A content block.
", "sensitive":true, "union":true }, "ContentBlocks":{ "type":"list", "member":{"shape":"ContentBlock"} }, "ContentBody":{ "type":"structure", "members":{ "body":{ "shape":"String", "documentation":"The body of the API response.
" }, "images":{ "shape":"ImageInputs", "documentation":"Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
The conversation's messages.
" } }, "documentation":"A conversation history.
" }, "ConversationRole":{ "type":"string", "enum":[ "user", "assistant" ] }, "CreateInvocationRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "description":{ "shape":"InvocationDescription", "documentation":"A description for the interactions in the invocation. For example, \"User asking about weather in Seattle\".
" }, "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" }, "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The timestamp for when the invocation was created.
" }, "invocationId":{ "shape":"Uuid", "documentation":"The unique identifier for the invocation.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session associated with the invocation.
" } } }, "CreateSessionRequest":{ "type":"structure", "members":{ "encryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
" }, "sessionMetadata":{ "shape":"SessionMetadataMap", "documentation":"A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
" }, "tags":{ "shape":"TagsMap", "documentation":"Specify the key-value pairs for the tags that you want to attach to the session.
" } } }, "CreateSessionResponse":{ "type":"structure", "required":[ "createdAt", "sessionArn", "sessionId", "sessionStatus" ], "members":{ "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was created.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the created session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session.
" } } }, "CreationMode":{ "type":"string", "enum":[ "DEFAULT", "OVERRIDDEN" ] }, "CustomControlMethod":{ "type":"string", "enum":["RETURN_CONTROL"] }, "CustomOrchestration":{ "type":"structure", "members":{ "executor":{ "shape":"OrchestrationExecutor", "documentation":"The structure of the executor invoking the actions in custom orchestration.
" } }, "documentation":"Contains details of the custom orchestration configured for the agent.
" }, "CustomOrchestrationTrace":{ "type":"structure", "members":{ "event":{ "shape":"CustomOrchestrationTraceEvent", "documentation":"The event details used with the custom orchestration.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"The trace behavior for the custom orchestration.
", "sensitive":true }, "CustomOrchestrationTraceEvent":{ "type":"structure", "members":{ "text":{ "shape":"String", "documentation":"The text that prompted the event at this step.
" } }, "documentation":"The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
", "sensitive":true }, "DateTimestamp":{ "type":"timestamp", "documentation":"Time Stamp.
", "timestampFormat":"iso8601" }, "DeleteAgentMemoryRequest":{ "type":"structure", "required":[ "agentAliasId", "agentId" ], "members":{ "agentAliasId":{ "shape":"AgentAliasId", "documentation":"The unique identifier of an alias of an agent.
", "location":"uri", "locationName":"agentAliasId" }, "agentId":{ "shape":"AgentId", "documentation":"The unique identifier of the agent to which the alias belongs.
", "location":"uri", "locationName":"agentId" }, "memoryId":{ "shape":"MemoryId", "documentation":"The unique identifier of the memory.
", "location":"querystring", "locationName":"memoryId" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique session identifier of the memory.
", "location":"querystring", "locationName":"sessionId" } } }, "DeleteAgentMemoryResponse":{ "type":"structure", "members":{} }, "DeleteSessionRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the session to be deleted. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" } }, "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "Document":{ "type":"structure", "members":{}, "document":true }, "Double":{ "type":"double", "box":true }, "EndSessionRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The Amazon Resource Name (ARN) of the session you ended.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier of the session you ended.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session you ended.
" } } }, "ExecutionType":{ "type":"string", "enum":[ "LAMBDA", "RETURN_CONTROL" ] }, "ExternalSource":{ "type":"structure", "required":["sourceType"], "members":{ "byteContent":{ "shape":"ByteContentDoc", "documentation":"The identifier, contentType, and data of the external source wrapper object.
" }, "s3Location":{ "shape":"S3ObjectDoc", "documentation":"The S3 location of the external source wrapper object.
" }, "sourceType":{ "shape":"ExternalSourceType", "documentation":"The source type of the external source wrapper object.
" } }, "documentation":"The unique external source of the content contained in the wrapper object.
" }, "ExternalSourceType":{ "type":"string", "enum":[ "S3", "BYTE_CONTENT" ] }, "ExternalSources":{ "type":"list", "member":{"shape":"ExternalSource"}, "max":1, "min":1 }, "ExternalSourcesGenerationConfiguration":{ "type":"structure", "members":{ "additionalModelRequestFields":{ "shape":"AdditionalModelRequestFields", "documentation":"Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
" }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", "documentation":"The configuration details for the guardrail.
" }, "inferenceConfig":{ "shape":"InferenceConfig", "documentation":"Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
" }, "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" }, "promptTemplate":{ "shape":"PromptTemplate", "documentation":"Contain the textPromptTemplate string for the external source wrapper object.
" } }, "documentation":"Contains the generation configuration of the external source wrapper object.
" }, "ExternalSourcesRetrieveAndGenerateConfiguration":{ "type":"structure", "required":[ "modelArn", "sources" ], "members":{ "generationConfiguration":{ "shape":"ExternalSourcesGenerationConfiguration", "documentation":"The prompt used with the external source wrapper object with the retrieveAndGenerate function.
The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.
The document for the external source wrapper object in the retrieveAndGenerate function.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
The failure code for the trace.
" }, "failureReason":{ "shape":"FailureReasonString", "documentation":"The reason the interaction failed.
" }, "metadata":{ "shape":"Metadata", "documentation":"Information about the failure that occurred.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"Contains information about the failure of the interaction.
", "sensitive":true }, "FieldForReranking":{ "type":"structure", "required":["fieldName"], "members":{ "fieldName":{ "shape":"FieldForRerankingFieldNameString", "documentation":"The name of a metadata field to include in or exclude from consideration when reranking.
" } }, "documentation":"Contains information for a metadata field to include in or exclude from consideration when reranking.
" }, "FieldForRerankingFieldNameString":{ "type":"string", "max":2000, "min":1 }, "FieldsForReranking":{ "type":"list", "member":{"shape":"FieldForReranking"}, "max":100, "min":1, "sensitive":true }, "FileBody":{ "type":"blob", "max":1000000, "min":0, "sensitive":true }, "FilePart":{ "type":"structure", "members":{ "files":{ "shape":"OutputFiles", "documentation":"Files containing intermediate response for the user.
" } }, "documentation":"Contains intermediate response for code interpreter if any files have been generated.
", "event":true }, "FileSource":{ "type":"structure", "required":["sourceType"], "members":{ "byteContent":{ "shape":"ByteContentFile", "documentation":"The data and the text of the attached files.
" }, "s3Location":{ "shape":"S3ObjectFile", "documentation":"The s3 location of the files to attach.
" }, "sourceType":{ "shape":"FileSourceType", "documentation":"The source type of the files to attach.
" } }, "documentation":"The source file of the content contained in the wrapper object.
" }, "FileSourceType":{ "type":"string", "enum":[ "S3", "BYTE_CONTENT" ] }, "FileUseCase":{ "type":"string", "enum":[ "CODE_INTERPRETER", "CHAT" ] }, "Files":{ "type":"list", "member":{"shape":"String"} }, "FilterAttribute":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"FilterKey", "documentation":"The name that the metadata attribute must match.
" }, "value":{ "shape":"FilterValue", "documentation":"The value to whcih to compare the value of the metadata attribute.
" } }, "documentation":"Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
" }, "FilterKey":{ "type":"string", "max":100, "min":1 }, "FilterValue":{ "type":"structure", "members":{}, "document":true }, "FinalResponse":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the invoke agent operation.
" }, "text":{ "shape":"FinalResponseString", "documentation":"The text in the response to the user.
" } }, "documentation":"Contains details about the response to the user.
" }, "FinalResponseString":{ "type":"string", "sensitive":true }, "Float":{ "type":"float", "box":true }, "FlowAliasIdentifier":{ "type":"string", "max":2048, "min":0, "pattern":"^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" }, "FlowCompletionEvent":{ "type":"structure", "required":["completionReason"], "members":{ "completionReason":{ "shape":"FlowCompletionReason", "documentation":"The reason that the flow completed.
" } }, "documentation":"Contains information about why a flow completed.
", "event":true, "sensitive":true }, "FlowCompletionReason":{ "type":"string", "enum":[ "SUCCESS", "INPUT_REQUIRED" ] }, "FlowControlNodeType":{ "type":"string", "enum":[ "Iterator", "Loop" ] }, "FlowErrorCode":{ "type":"string", "enum":[ "VALIDATION", "INTERNAL_SERVER", "NODE_EXECUTION_FAILED" ] }, "FlowExecutionContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The document content of the field, which can contain text or structured data.
" } }, "documentation":"Contains the content of an flow execution input or output field.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The error code for the type of error that occurred.
" }, "message":{ "shape":"String", "documentation":"A descriptive message that provides details about the error.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node in the flow where the error occurred (if applicable).
" } }, "documentation":"Contains information about an error that occurred during an flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
" }, "flowFailureEvent":{ "shape":"FlowFailureEvent", "documentation":"Contains information about a failure that occurred at the flow level during execution.
" }, "flowInputEvent":{ "shape":"FlowExecutionInputEvent", "documentation":"Contains information about the inputs provided to the flow at the start of execution.
" }, "flowOutputEvent":{ "shape":"FlowExecutionOutputEvent", "documentation":"Contains information about the outputs produced by the flow at the end of execution.
" }, "nodeActionEvent":{ "shape":"NodeActionEvent", "documentation":"Contains information about an action (operation) called by a node during execution.
" }, "nodeDependencyEvent":{ "shape":"NodeDependencyEvent", "documentation":"Contains information about an internal trace of a specific node during execution.
" }, "nodeFailureEvent":{ "shape":"NodeFailureEvent", "documentation":"Contains information about a failure that occurred at a specific node during execution.
" }, "nodeInputEvent":{ "shape":"NodeInputEvent", "documentation":"Contains information about the inputs provided to a specific node during execution.
" }, "nodeOutputEvent":{ "shape":"NodeOutputEvent", "documentation":"Contains information about the outputs produced by a specific node during execution.
" } }, "documentation":"Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the flow.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that receives the inputs.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the inputs are provided.
" } }, "documentation":"Contains information about the inputs provided to the flow at the start of a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of output fields produced by the flow.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that produces the outputs.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the outputs are produced.
" } }, "documentation":"Contains information about the outputs produced by the flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the flow execution was created.
" }, "endedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" }, "executionArn":{ "shape":"FlowExecutionIdentifier", "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
" }, "flowVersion":{ "shape":"Version", "documentation":"The version of the flow used for the execution.
" }, "status":{ "shape":"FlowExecutionStatus", "documentation":"The current status of the flow execution.
Flow executions time out after 24 hours.
" } }, "documentation":"Contains summary information about a flow execution, including its status, timestamps, and identifiers.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The error code that identifies the type of failure that occurred.
" }, "errorMessage":{ "shape":"String", "documentation":"A descriptive message that provides details about the failure.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the failure occurred.
" } }, "documentation":"Contains information about a failure that occurred at the flow level during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about an input into the prompt flow.
" }, "nodeInputName":{ "shape":"NodeInputName", "documentation":"The name of the input from the flow input node.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the flow input node that begins the prompt flow.
" }, "nodeOutputName":{ "shape":"NodeOutputName", "documentation":"The name of the output from the flow input node that begins the prompt flow.
" } }, "documentation":"Contains information about an input into the prompt flow and where to send it.
" }, "FlowInputContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The input to send to the prompt flow input node.
" } }, "documentation":"Contains information about an input into the flow.
", "sensitive":true, "union":true }, "FlowInputField":{ "type":"structure", "required":[ "content", "name" ], "members":{ "content":{ "shape":"FlowExecutionContent", "documentation":"The content of the input field, which can contain text or structured data.
" }, "name":{ "shape":"NodeInputName", "documentation":"The name of the input field as defined in the flow's input schema.
" } }, "documentation":"Represents an input field provided to a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The requested additional input to send back to the multi-turn flow node.
" } }, "documentation":"The content structure containing input information for multi-turn flow interactions.
", "union":true }, "FlowMultiTurnInputRequestEvent":{ "type":"structure", "required":[ "content", "nodeName", "nodeType" ], "members":{ "content":{ "shape":"FlowMultiTurnInputContent", "documentation":"The content payload containing the input request details for the multi-turn interaction.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node in the flow that is requesting the input.
" }, "nodeType":{ "shape":"NodeType", "documentation":"The type of the node in the flow that is requesting the input.
" } }, "documentation":"Response object from the flow multi-turn node requesting additional information.
", "event":true, "sensitive":true }, "FlowNodeIODataType":{ "type":"string", "enum":[ "String", "Number", "Boolean", "Object", "Array" ] }, "FlowNodeInputCategory":{ "type":"string", "enum":[ "LoopCondition", "ReturnValueToLoopStart", "ExitLoop" ] }, "FlowNodeInputExpression":{ "type":"string", "max":64, "min":1, "sensitive":true }, "FlowNodeInputName":{ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" }, "FlowNodeOutputName":{ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" }, "FlowOutputContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The content in the output.
" } }, "documentation":"Contains information about the content in an output from prompt flow invocation.
", "union":true }, "FlowOutputEvent":{ "type":"structure", "required":[ "content", "nodeName", "nodeType" ], "members":{ "content":{ "shape":"FlowOutputContent", "documentation":"The content in the output.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the flow output node that the output is from.
" }, "nodeType":{ "shape":"NodeType", "documentation":"The type of the node that the output is from.
" } }, "documentation":"Contains information about an output from prompt flow invoction.
", "event":true, "sensitive":true }, "FlowOutputField":{ "type":"structure", "required":[ "content", "name" ], "members":{ "content":{ "shape":"FlowExecutionContent", "documentation":"The content of the output field, which can contain text or structured data.
" }, "name":{ "shape":"NodeOutputName", "documentation":"The name of the output field as defined in the flow's output schema.
" } }, "documentation":"Represents an output field produced by a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, "badGatewayException":{ "shape":"BadGatewayException", "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" }, "conflictException":{ "shape":"ConflictException", "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" }, "dependencyFailedException":{ "shape":"DependencyFailedException", "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" }, "flowCompletionEvent":{ "shape":"FlowCompletionEvent", "documentation":"Contains information about why the flow completed.
" }, "flowMultiTurnInputRequestEvent":{ "shape":"FlowMultiTurnInputRequestEvent", "documentation":"The event stream containing the multi-turn input request information from the flow.
" }, "flowOutputEvent":{ "shape":"FlowOutputEvent", "documentation":"Contains information about an output from flow invocation.
" }, "flowTraceEvent":{ "shape":"FlowTraceEvent", "documentation":"Contains information about a trace, which tracks an input or output for a node in the flow.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, "validationException":{ "shape":"ValidationException", "documentation":"Input validation failed. Check your request parameters and retry the request.
" } }, "documentation":"The output of the flow.
", "eventstream":true }, "FlowTrace":{ "type":"structure", "members":{ "conditionNodeResultTrace":{ "shape":"FlowTraceConditionNodeResultEvent", "documentation":"Contains information about an output from a condition node.
" }, "nodeActionTrace":{ "shape":"FlowTraceNodeActionEvent", "documentation":"Contains information about an action (operation) called by a node.
" }, "nodeDependencyTrace":{ "shape":"FlowTraceDependencyEvent", "documentation":"Contains information about an internal trace of a node.
" }, "nodeInputTrace":{ "shape":"FlowTraceNodeInputEvent", "documentation":"Contains information about the input into a node.
" }, "nodeOutputTrace":{ "shape":"FlowTraceNodeOutputEvent", "documentation":"Contains information about the output from a node.
" } }, "documentation":"Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true, "union":true }, "FlowTraceCondition":{ "type":"structure", "required":["conditionName"], "members":{ "conditionName":{ "shape":"String", "documentation":"The name of the condition.
" } }, "documentation":"Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceConditionNodeResultEvent":{ "type":"structure", "required":[ "nodeName", "satisfiedConditions", "timestamp" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the condition node.
" }, "satisfiedConditions":{ "shape":"FlowTraceConditions", "documentation":"An array of objects containing information about the conditions that were satisfied.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" } }, "documentation":"Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceConditions":{ "type":"list", "member":{"shape":"FlowTraceCondition"}, "max":5, "min":1 }, "FlowTraceDependencyEvent":{ "type":"structure", "required":[ "nodeName", "timestamp", "traceElements" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that generated the dependency trace.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the dependency trace was generated.
" }, "traceElements":{ "shape":"TraceElements", "documentation":"The trace elements containing detailed information about the dependency.
" } }, "documentation":"Contains information about a dependency trace event in the flow.
", "sensitive":true }, "FlowTraceEvent":{ "type":"structure", "required":["trace"], "members":{ "trace":{ "shape":"FlowTrace", "documentation":"The trace object containing information about an input or output for a node in the flow.
" } }, "documentation":"Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "event":true }, "FlowTraceNodeActionEvent":{ "type":"structure", "required":[ "nodeName", "operationName", "requestId", "serviceName", "timestamp" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that called the operation.
" }, "operationName":{ "shape":"String", "documentation":"The name of the operation that the node called.
" }, "operationRequest":{ "shape":"Document", "documentation":"The request payload sent to the downstream service.
" }, "operationResponse":{ "shape":"Document", "documentation":"The response payload received from the downstream service.
" }, "requestId":{ "shape":"String", "documentation":"The ID of the request that the node made to the operation.
" }, "serviceName":{ "shape":"String", "documentation":"The name of the service that the node called.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the operation was called.
" } }, "documentation":"Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
", "sensitive":true }, "FlowTraceNodeInputContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The content of the node input.
" } }, "documentation":"Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true, "union":true }, "FlowTraceNodeInputEvent":{ "type":"structure", "required":[ "fields", "nodeName", "timestamp" ], "members":{ "fields":{ "shape":"FlowTraceNodeInputFields", "documentation":"An array of objects containing information about each field in the input.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that received the input.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" } }, "documentation":"Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceNodeInputExecutionChain":{ "type":"list", "member":{"shape":"FlowTraceNodeInputExecutionChainItem"}, "sensitive":true }, "FlowTraceNodeInputExecutionChainItem":{ "type":"structure", "required":[ "nodeName", "type" ], "members":{ "index":{ "shape":"Integer", "documentation":"The index position of this item in the execution chain.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node in the execution chain.
" }, "type":{ "shape":"FlowControlNodeType", "documentation":"The type of execution chain item. Supported values are Iterator and Loop.
" } }, "documentation":"Represents an item in the execution chain for flow trace node input tracking.
", "sensitive":true }, "FlowTraceNodeInputField":{ "type":"structure", "required":[ "content", "nodeInputName" ], "members":{ "category":{ "shape":"FlowNodeInputCategory", "documentation":"The category of the input field.
" }, "content":{ "shape":"FlowTraceNodeInputContent", "documentation":"The content of the node input.
" }, "executionChain":{ "shape":"FlowTraceNodeInputExecutionChain", "documentation":"The execution path through nested nodes like iterators and loops.
" }, "nodeInputName":{ "shape":"NodeInputName", "documentation":"The name of the node input.
" }, "source":{ "shape":"FlowTraceNodeInputSource", "documentation":"The source node that provides input data to this field.
" }, "type":{ "shape":"FlowNodeIODataType", "documentation":"The data type of the input field for compatibility validation.
" } }, "documentation":"Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceNodeInputFields":{ "type":"list", "member":{"shape":"FlowTraceNodeInputField"}, "max":5, "min":1 }, "FlowTraceNodeInputSource":{ "type":"structure", "required":[ "expression", "nodeName", "outputFieldName" ], "members":{ "expression":{ "shape":"FlowNodeInputExpression", "documentation":"The expression used to extract data from the source.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the source node that provides the input data.
" }, "outputFieldName":{ "shape":"FlowNodeOutputName", "documentation":"The name of the output field from the source node.
" } }, "documentation":"Represents the source of input data for a flow trace node field.
", "sensitive":true }, "FlowTraceNodeOutputContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The content of the node output.
" } }, "documentation":"Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "union":true }, "FlowTraceNodeOutputEvent":{ "type":"structure", "required":[ "fields", "nodeName", "timestamp" ], "members":{ "fields":{ "shape":"FlowTraceNodeOutputFields", "documentation":"An array of objects containing information about each field in the output.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that yielded the output.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the trace was returned.
" } }, "documentation":"Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceNodeOutputField":{ "type":"structure", "required":[ "content", "nodeOutputName" ], "members":{ "content":{ "shape":"FlowTraceNodeOutputContent", "documentation":"The content of the node output.
" }, "next":{ "shape":"FlowTraceNodeOutputNextList", "documentation":"The next node that receives output data from this field.
" }, "nodeOutputName":{ "shape":"NodeOutputName", "documentation":"The name of the node output.
" }, "type":{ "shape":"FlowNodeIODataType", "documentation":"The data type of the output field for compatibility validation.
" } }, "documentation":"Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", "sensitive":true }, "FlowTraceNodeOutputFields":{ "type":"list", "member":{"shape":"FlowTraceNodeOutputField"}, "max":2, "min":1 }, "FlowTraceNodeOutputNext":{ "type":"structure", "required":[ "inputFieldName", "nodeName" ], "members":{ "inputFieldName":{ "shape":"FlowNodeInputName", "documentation":"The name of the input field in the next node that receives the data.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the next node that receives the output data.
" } }, "documentation":"Represents the next node that receives output data from a flow trace.
", "sensitive":true }, "FlowTraceNodeOutputNextList":{ "type":"list", "member":{"shape":"FlowTraceNodeOutputNext"} }, "Function":{ "type":"string", "sensitive":true }, "FunctionDefinition":{ "type":"structure", "required":["name"], "members":{ "description":{ "shape":"FunctionDescription", "documentation":"A description of the function and its purpose.
" }, "name":{ "shape":"ResourceName", "documentation":"A name for the function.
" }, "parameters":{ "shape":"ParameterMap", "documentation":"The parameters that the agent elicits from the user to fulfill the function.
" }, "requireConfirmation":{ "shape":"RequireConfirmation", "documentation":"Contains information if user confirmation is required to invoke the function.
" } }, "documentation":"Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
" }, "FunctionDescription":{ "type":"string", "max":1200, "min":1 }, "FunctionInvocationInput":{ "type":"structure", "required":["actionGroup"], "members":{ "actionGroup":{ "shape":"String", "documentation":"The action group that the function belongs to.
" }, "actionInvocationType":{ "shape":"ActionInvocationType", "documentation":"Contains information about the function to invoke,
" }, "agentId":{ "shape":"String", "documentation":"The agent's ID.
" }, "collaboratorName":{ "shape":"Name", "documentation":"The collaborator's name.
" }, "function":{ "shape":"String", "documentation":"The name of the function.
" }, "parameters":{ "shape":"FunctionParameters", "documentation":"A list of parameters of the function.
" } }, "documentation":"Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The name of the parameter.
" }, "type":{ "shape":"String", "documentation":"The data type of the parameter.
" }, "value":{ "shape":"String", "documentation":"The value of the parameter.
" } }, "documentation":"Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The action group that the function belongs to.
" }, "agentId":{ "shape":"String", "documentation":"The agent's ID.
" }, "confirmationState":{ "shape":"ConfirmationState", "documentation":"Contains the user confirmation information about the function that was called.
" }, "function":{ "shape":"String", "documentation":"The name of the function that was called.
" }, "responseBody":{ "shape":"ResponseBody", "documentation":"The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
" } }, "documentation":"Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
A list of functions that each define an action in the action group.
" } }, "documentation":"Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
", "union":true }, "Functions":{ "type":"list", "member":{"shape":"FunctionDefinition"} }, "GenerateQueryRequest":{ "type":"structure", "required":[ "queryGenerationInput", "transformationConfiguration" ], "members":{ "queryGenerationInput":{ "shape":"QueryGenerationInput", "documentation":"Specifies information about a natural language query to transform into SQL.
" }, "transformationConfiguration":{ "shape":"TransformationConfiguration", "documentation":"Specifies configurations for transforming the natural language query into SQL.
" } } }, "GenerateQueryResponse":{ "type":"structure", "members":{ "queries":{ "shape":"GeneratedQueries", "documentation":"A list of objects, each of which defines a generated query that can correspond to the natural language queries.
" } } }, "GeneratedQueries":{ "type":"list", "member":{"shape":"GeneratedQuery"}, "min":0 }, "GeneratedQuery":{ "type":"structure", "members":{ "sql":{ "shape":"String", "documentation":"An SQL query that corresponds to the natural language query.
" }, "type":{ "shape":"GeneratedQueryType", "documentation":"The type of transformed query.
" } }, "documentation":"Contains information about a query generated for a natural language query.
", "sensitive":true }, "GeneratedQueryType":{ "type":"string", "enum":["REDSHIFT_SQL"] }, "GeneratedResponsePart":{ "type":"structure", "members":{ "textResponsePart":{ "shape":"TextResponsePart", "documentation":"Contains metadata about a textual part of the generated response that is accompanied by a citation.
" } }, "documentation":"Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
" }, "guardrailConfiguration":{ "shape":"GuardrailConfiguration", "documentation":"The configuration details for the guardrail.
" }, "inferenceConfig":{ "shape":"InferenceConfig", "documentation":"Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" }, "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" }, "promptTemplate":{ "shape":"PromptTemplate", "documentation":"Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.
Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" }, "GetAgentMemoryRequest":{ "type":"structure", "required":[ "agentAliasId", "agentId", "memoryId", "memoryType" ], "members":{ "agentAliasId":{ "shape":"AgentAliasId", "documentation":"The unique identifier of an alias of an agent.
", "location":"uri", "locationName":"agentAliasId" }, "agentId":{ "shape":"AgentId", "documentation":"The unique identifier of the agent to which the alias belongs.
", "location":"uri", "locationName":"agentId" }, "maxItems":{ "shape":"MaxResults", "documentation":"The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier of the memory.
", "location":"querystring", "locationName":"memoryId" }, "memoryType":{ "shape":"MemoryType", "documentation":"The type of memory.
", "location":"querystring", "locationName":"memoryType" }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Contains details of the sessions stored in the memory
" }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The unique identifier of the flow execution.
", "location":"uri", "locationName":"executionIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the flow execution.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
", "location":"uri", "locationName":"flowIdentifier" } } }, "GetExecutionFlowSnapshotResponse":{ "type":"structure", "required":[ "definition", "executionRoleArn", "flowAliasIdentifier", "flowIdentifier", "flowVersion" ], "members":{ "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" }, "definition":{ "shape":"String", "documentation":"The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
" }, "executionRoleArn":{ "shape":"FlowExecutionRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the flow execution.
" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
" }, "flowVersion":{ "shape":"Version", "documentation":"The version of the flow used for the flow execution.
" } } }, "GetFlowExecutionRequest":{ "type":"structure", "required":[ "executionIdentifier", "flowAliasIdentifier", "flowIdentifier" ], "members":{ "executionIdentifier":{ "shape":"FlowExecutionIdentifier", "documentation":"The unique identifier of the flow execution to retrieve.
", "location":"uri", "locationName":"executionIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
", "location":"uri", "locationName":"flowIdentifier" } } }, "GetFlowExecutionResponse":{ "type":"structure", "required":[ "executionArn", "flowAliasIdentifier", "flowIdentifier", "flowVersion", "startedAt", "status" ], "members":{ "endedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" }, "errors":{ "shape":"FlowExecutionErrors", "documentation":"A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
" }, "executionArn":{ "shape":"FlowExecutionIdentifier", "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
" }, "flowVersion":{ "shape":"Version", "documentation":"The version of the flow used for the execution.
" }, "startedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the flow execution started.
" }, "status":{ "shape":"FlowExecutionStatus", "documentation":"The current status of the flow execution.
Flow executions time out after 24 hours.
" } } }, "GetInvocationStepRequest":{ "type":"structure", "required":[ "invocationIdentifier", "invocationStepId", "sessionIdentifier" ], "members":{ "invocationIdentifier":{ "shape":"InvocationIdentifier", "documentation":"The unique identifier for the invocation in UUID format.
" }, "invocationStepId":{ "shape":"Uuid", "documentation":"The unique identifier (in UUID format) for the specific invocation step to retrieve.
", "location":"uri", "locationName":"invocationStepId" }, "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the invocation step's associated session. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The complete details of the requested invocation step.
" } } }, "GetSessionRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"A unique identifier for the session to retrieve. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The timestamp for when the session was created.
" }, "encryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was last modified.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session in UUID format.
" }, "sessionMetadata":{ "shape":"SessionMetadataMap", "documentation":"A map of key-value pairs containing attributes persisted across the session.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session.
" } } }, "GuadrailAction":{ "type":"string", "enum":[ "INTERVENED", "NONE" ] }, "GuardrailAction":{ "type":"string", "enum":[ "INTERVENED", "NONE" ] }, "GuardrailAssessment":{ "type":"structure", "members":{ "contentPolicy":{ "shape":"GuardrailContentPolicyAssessment", "documentation":"Content policy details of the Guardrail.
" }, "sensitiveInformationPolicy":{ "shape":"GuardrailSensitiveInformationPolicyAssessment", "documentation":"Sensitive Information policy details of Guardrail.
" }, "topicPolicy":{ "shape":"GuardrailTopicPolicyAssessment", "documentation":"Topic policy details of the Guardrail.
" }, "wordPolicy":{ "shape":"GuardrailWordPolicyAssessment", "documentation":"Word policy details of the Guardrail.
" } }, "documentation":"Assessment details of the content analyzed by Guardrails.
", "sensitive":true }, "GuardrailAssessmentList":{ "type":"list", "member":{"shape":"GuardrailAssessment"} }, "GuardrailConfiguration":{ "type":"structure", "required":[ "guardrailId", "guardrailVersion" ], "members":{ "guardrailId":{ "shape":"GuardrailConfigurationGuardrailIdString", "documentation":"The unique identifier for the guardrail.
" }, "guardrailVersion":{ "shape":"GuardrailConfigurationGuardrailVersionString", "documentation":"The version of the guardrail.
" } }, "documentation":"The configuration details for the guardrail.
" }, "GuardrailConfigurationGuardrailIdString":{ "type":"string", "max":64, "min":0, "pattern":"^[a-z0-9]+$" }, "GuardrailConfigurationGuardrailVersionString":{ "type":"string", "max":5, "min":1, "pattern":"^(([1-9][0-9]{0,7})|(DRAFT))$" }, "GuardrailConfigurationWithArn":{ "type":"structure", "required":[ "guardrailIdentifier", "guardrailVersion" ], "members":{ "guardrailIdentifier":{ "shape":"GuardrailIdentifierWithArn", "documentation":"The unique identifier for the guardrail.
" }, "guardrailVersion":{ "shape":"GuardrailVersion", "documentation":"The version of the guardrail.
" } }, "documentation":"The configuration details for the guardrail.
" }, "GuardrailContentFilter":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailContentPolicyAction", "documentation":"The action placed on the content by the Guardrail filter.
" }, "confidence":{ "shape":"GuardrailContentFilterConfidence", "documentation":"The confidence level regarding the content detected in the filter by the Guardrail.
" }, "type":{ "shape":"GuardrailContentFilterType", "documentation":"The type of content detected in the filter by the Guardrail.
" } }, "documentation":"Details of the content filter used in the Guardrail.
", "sensitive":true }, "GuardrailContentFilterConfidence":{ "type":"string", "enum":[ "NONE", "LOW", "MEDIUM", "HIGH" ] }, "GuardrailContentFilterList":{ "type":"list", "member":{"shape":"GuardrailContentFilter"}, "sensitive":true }, "GuardrailContentFilterType":{ "type":"string", "enum":[ "INSULTS", "HATE", "SEXUAL", "VIOLENCE", "MISCONDUCT", "PROMPT_ATTACK" ] }, "GuardrailContentPolicyAction":{ "type":"string", "enum":["BLOCKED"] }, "GuardrailContentPolicyAssessment":{ "type":"structure", "members":{ "filters":{ "shape":"GuardrailContentFilterList", "documentation":"The filter details of the policy assessment used in the Guardrails filter.
" } }, "documentation":"The details of the policy assessment in the Guardrails filter.
", "sensitive":true }, "GuardrailCustomWord":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailWordPolicyAction", "documentation":"The action details for the custom word filter in the Guardrail.
" }, "match":{ "shape":"String", "documentation":"The match details for the custom word filter in the Guardrail.
" } }, "documentation":"The custom word details for the filter in the Guardrail.
", "sensitive":true }, "GuardrailCustomWordList":{ "type":"list", "member":{"shape":"GuardrailCustomWord"}, "sensitive":true }, "GuardrailEvent":{ "type":"structure", "members":{ "action":{ "shape":"GuadrailAction", "documentation":"The guardrail action.
" } }, "documentation":"A guardrail event.
", "event":true }, "GuardrailIdentifierWithArn":{ "type":"string", "max":2048, "min":0, "pattern":"^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" }, "GuardrailManagedWord":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailWordPolicyAction", "documentation":"The action details for the managed word filter in the Guardrail.
" }, "match":{ "shape":"String", "documentation":"The match details for the managed word filter in the Guardrail.
" }, "type":{ "shape":"GuardrailManagedWordType", "documentation":"The type details for the managed word filter in the Guardrail.
" } }, "documentation":"The managed word details for the filter in the Guardrail.
", "sensitive":true }, "GuardrailManagedWordList":{ "type":"list", "member":{"shape":"GuardrailManagedWord"}, "sensitive":true }, "GuardrailManagedWordType":{ "type":"string", "enum":["PROFANITY"] }, "GuardrailPiiEntityFilter":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailSensitiveInformationPolicyAction", "documentation":"The action of the Guardrail filter to identify and remove PII.
" }, "match":{ "shape":"String", "documentation":"The match to settings in the Guardrail filter to identify and remove PII.
" }, "type":{ "shape":"GuardrailPiiEntityType", "documentation":"The type of PII the Guardrail filter has identified and removed.
" } }, "documentation":"The Guardrail filter to identify and remove personally identifiable information (PII).
", "sensitive":true }, "GuardrailPiiEntityFilterList":{ "type":"list", "member":{"shape":"GuardrailPiiEntityFilter"}, "sensitive":true }, "GuardrailPiiEntityType":{ "type":"string", "enum":[ "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" ] }, "GuardrailRegexFilter":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailSensitiveInformationPolicyAction", "documentation":"The action details for the regex filter used in the Guardrail.
" }, "match":{ "shape":"String", "documentation":"The match details for the regex filter used in the Guardrail.
" }, "name":{ "shape":"String", "documentation":"The name details for the regex filter used in the Guardrail.
" }, "regex":{ "shape":"String", "documentation":"The regex details for the regex filter used in the Guardrail.
" } }, "documentation":"The details for the regex filter used in the Guardrail.
", "sensitive":true }, "GuardrailRegexFilterList":{ "type":"list", "member":{"shape":"GuardrailRegexFilter"}, "sensitive":true }, "GuardrailSensitiveInformationPolicyAction":{ "type":"string", "enum":[ "BLOCKED", "ANONYMIZED" ] }, "GuardrailSensitiveInformationPolicyAssessment":{ "type":"structure", "members":{ "piiEntities":{ "shape":"GuardrailPiiEntityFilterList", "documentation":"The details of the PII entities used in the sensitive policy assessment for the Guardrail.
" }, "regexes":{ "shape":"GuardrailRegexFilterList", "documentation":"The details of the regexes used in the sensitive policy assessment for the Guardrail.
" } }, "documentation":"The details of the sensitive policy assessment used in the Guardrail.
", "sensitive":true }, "GuardrailTopic":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailTopicPolicyAction", "documentation":"The action details on a specific topic in the Guardrail.
" }, "name":{ "shape":"String", "documentation":"The name details on a specific topic in the Guardrail.
" }, "type":{ "shape":"GuardrailTopicType", "documentation":"The type details on a specific topic in the Guardrail.
" } }, "documentation":"The details for a specific topic defined in the Guardrail.
", "sensitive":true }, "GuardrailTopicList":{ "type":"list", "member":{"shape":"GuardrailTopic"}, "sensitive":true }, "GuardrailTopicPolicyAction":{ "type":"string", "enum":["BLOCKED"] }, "GuardrailTopicPolicyAssessment":{ "type":"structure", "members":{ "topics":{ "shape":"GuardrailTopicList", "documentation":"The topic details of the policy assessment used in the Guardrail.
" } }, "documentation":"The details of the policy assessment used in the Guardrail.
", "sensitive":true }, "GuardrailTopicType":{ "type":"string", "enum":["DENY"] }, "GuardrailTrace":{ "type":"structure", "members":{ "action":{ "shape":"GuardrailAction", "documentation":"The trace action details used with the Guardrail.
" }, "inputAssessments":{ "shape":"GuardrailAssessmentList", "documentation":"The details of the input assessments used in the Guardrail Trace.
" }, "metadata":{ "shape":"Metadata", "documentation":"Contains information about the Guardrail output.
" }, "outputAssessments":{ "shape":"GuardrailAssessmentList", "documentation":"The details of the output assessments used in the Guardrail Trace.
" }, "traceId":{ "shape":"TraceId", "documentation":"The details of the trace Id used in the Guardrail Trace.
" } }, "documentation":"The trace details used in the Guardrail.
", "sensitive":true }, "GuardrailVersion":{ "type":"string", "max":5, "min":1, "pattern":"^(([1-9][0-9]{0,7})|(DRAFT))$" }, "GuardrailWordPolicyAction":{ "type":"string", "enum":["BLOCKED"] }, "GuardrailWordPolicyAssessment":{ "type":"structure", "members":{ "customWords":{ "shape":"GuardrailCustomWordList", "documentation":"The custom word details for words defined in the Guardrail filter.
" }, "managedWordLists":{ "shape":"GuardrailManagedWordList", "documentation":"The managed word lists for words defined in the Guardrail filter.
" } }, "documentation":"The assessment details for words defined in the Guardrail filter.
", "sensitive":true }, "Identifier":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "ImageBlock":{ "type":"structure", "required":[ "format", "source" ], "members":{ "format":{ "shape":"ImageFormat", "documentation":"The format of the image.
" }, "source":{ "shape":"ImageSource", "documentation":"The source for the image.
" } }, "documentation":"Image content for an invocation step.
" }, "ImageFormat":{ "type":"string", "enum":[ "png", "jpeg", "gif", "webp" ] }, "ImageInput":{ "type":"structure", "required":[ "format", "source" ], "members":{ "format":{ "shape":"ImageInputFormat", "documentation":"The type of image in the result.
" }, "source":{ "shape":"ImageInputSource", "documentation":"The source of the image in the result.
" } }, "documentation":"Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
" }, "ImageInputFormat":{ "type":"string", "enum":[ "png", "jpeg", "gif", "webp" ] }, "ImageInputSource":{ "type":"structure", "members":{ "bytes":{ "shape":"ImageInputSourceBytesBlob", "documentation":"The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.
" } }, "documentation":"Details about the source of an input image in the result from a function in the action group invocation.
", "union":true }, "ImageInputSourceBytesBlob":{ "type":"blob", "min":1 }, "ImageInputs":{ "type":"list", "member":{"shape":"ImageInput"} }, "ImageSource":{ "type":"structure", "members":{ "bytes":{ "shape":"ImageSourceBytesBlob", "documentation":"The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.
" }, "s3Location":{ "shape":"S3Location", "documentation":"The path to the Amazon S3 bucket where the image is stored.
" } }, "documentation":"The source for an image.
", "union":true }, "ImageSourceBytesBlob":{ "type":"blob", "min":1 }, "ImplicitFilterConfiguration":{ "type":"structure", "required":[ "metadataAttributes", "modelArn" ], "members":{ "metadataAttributes":{ "shape":"MetadataAttributeSchemaList", "documentation":"Metadata that can be used in a filter.
" }, "modelArn":{ "shape":"BedrockModelArn", "documentation":"The model that generates the filter.
" } }, "documentation":"Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
" }, "InferenceConfig":{ "type":"structure", "members":{ "textInferenceConfig":{ "shape":"TextInferenceConfig", "documentation":"Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
" } }, "documentation":"The configuration for inference settings when generating responses using RetrieveAndGenerate.
" }, "InferenceConfiguration":{ "type":"structure", "members":{ "maximumLength":{ "shape":"MaximumLength", "documentation":"The maximum number of tokens allowed in the generated response.
" }, "stopSequences":{ "shape":"StopSequences", "documentation":"A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" }, "temperature":{ "shape":"Temperature", "documentation":"The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" }, "topK":{ "shape":"TopK", "documentation":"While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" }, "InlineAgentFilePart":{ "type":"structure", "members":{ "files":{ "shape":"OutputFiles", "documentation":"Files containing intermediate response for the user.
" } }, "documentation":"Contains intermediate response for code interpreter if any files have been generated.
", "event":true }, "InlineAgentPayloadPart":{ "type":"structure", "members":{ "attribution":{ "shape":"Attribution", "documentation":"Contains citations for a part of an agent response.
" }, "bytes":{ "shape":"PartBody", "documentation":"A part of the agent response in bytes.
" } }, "documentation":"Contains a part of an agent response and citations for it.
", "event":true, "sensitive":true }, "InlineAgentResponseStream":{ "type":"structure", "members":{ "accessDeniedException":{ "shape":"AccessDeniedException", "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, "badGatewayException":{ "shape":"BadGatewayException", "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" }, "chunk":{ "shape":"InlineAgentPayloadPart", "documentation":"Contains a part of an agent response and citations for it.
" }, "conflictException":{ "shape":"ConflictException", "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" }, "dependencyFailedException":{ "shape":"DependencyFailedException", "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" }, "files":{ "shape":"InlineAgentFilePart", "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" }, "returnControl":{ "shape":"InlineAgentReturnControlPayload", "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, "trace":{ "shape":"InlineAgentTracePart", "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" }, "validationException":{ "shape":"ValidationException", "documentation":"Input validation failed. Check your request parameters and retry the request.
" } }, "documentation":"The response from invoking the agent and associated citations and trace information.
", "eventstream":true }, "InlineAgentReturnControlPayload":{ "type":"structure", "members":{ "invocationId":{ "shape":"String", "documentation":"The identifier of the action group invocation.
" }, "invocationInputs":{ "shape":"InvocationInputs", "documentation":"A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" } }, "documentation":"Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
", "event":true, "sensitive":true }, "InlineAgentTracePart":{ "type":"structure", "members":{ "callerChain":{ "shape":"CallerChain", "documentation":"The caller chain for the trace part.
" }, "collaboratorName":{ "shape":"Name", "documentation":"The collaborator name for the trace part.
" }, "eventTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time that trace occurred.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
" }, "trace":{ "shape":"Trace", "documentation":"Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" } }, "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "event":true, "sensitive":true }, "InlineBedrockModelConfigurations":{ "type":"structure", "members":{ "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" } }, "documentation":"Settings for a model called with InvokeInlineAgent.
" }, "InlineSessionState":{ "type":"structure", "members":{ "conversationHistory":{ "shape":"ConversationHistory", "documentation":"Contains the conversation history that persist across sessions.
" }, "files":{ "shape":"InputFiles", "documentation":"Contains information about the files used by code interpreter.
" }, "invocationId":{ "shape":"String", "documentation":" The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.
Contains attributes that persist across a session and the values of those attributes.
" }, "returnControlInvocationResults":{ "shape":"ReturnControlInvocationResults", "documentation":"Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState field, the inputText field will be ignored.
Contains attributes that persist across a session and the values of those attributes.
" } }, "documentation":" Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
The name of the source file.
" }, "source":{ "shape":"FileSource", "documentation":"Specifies where the files are located.
" }, "useCase":{ "shape":"FileUseCase", "documentation":"Specifies how the source files will be used by the code interpreter.
" } }, "documentation":"Contains details of the source files.
" }, "InputFiles":{ "type":"list", "member":{"shape":"InputFile"} }, "InputImage":{ "type":"structure", "required":[ "format", "inlineContent" ], "members":{ "format":{ "shape":"InputImageFormat", "documentation":"The format of the input image. Supported formats include png, gif, jpeg, and webp.
" }, "inlineContent":{ "shape":"InputImageInlineContentBlob", "documentation":"The base64-encoded image data for inline image content. Maximum size is 5MB.
" } }, "documentation":"Contains the image data for multimodal knowledge base queries, including format and content.
This data type is used in the following API operations:
Retrieve request – in the image field
Contains information about the text prompt to optimize.
" } }, "documentation":"Contains information about the prompt to optimize.
", "union":true }, "InputQueryType":{ "type":"string", "enum":["TEXT"] }, "InputText":{ "type":"string", "max":25000000, "min":0, "sensitive":true }, "Instruction":{ "type":"string", "min":40, "sensitive":true }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"}, "reason":{ "shape":"String", "documentation":"The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model invocation service is unavailable. Retry your request.
An internal server error occurred. Retry your request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvocationDescription":{ "type":"string", "max":200, "min":1 }, "InvocationIdentifier":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "InvocationInput":{ "type":"structure", "members":{ "actionGroupInvocationInput":{ "shape":"ActionGroupInvocationInput", "documentation":"Contains information about the action group to be invoked.
" }, "agentCollaboratorInvocationInput":{ "shape":"AgentCollaboratorInvocationInput", "documentation":"The collaborator's invocation input.
" }, "codeInterpreterInvocationInput":{ "shape":"CodeInterpreterInvocationInput", "documentation":"Contains information about the code interpreter to be invoked.
" }, "invocationType":{ "shape":"InvocationType", "documentation":"Specifies whether the agent is invoking an action group or a knowledge base.
" }, "knowledgeBaseLookupInput":{ "shape":"KnowledgeBaseLookupInput", "documentation":"Contains details about the knowledge base to look up and the query to be made.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"Contains information pertaining to the action group or knowledge base that is being invoked.
", "sensitive":true }, "InvocationInputMember":{ "type":"structure", "members":{ "apiInvocationInput":{ "shape":"ApiInvocationInput", "documentation":"Contains information about the API operation that the agent predicts should be called.
" }, "functionInvocationInput":{ "shape":"FunctionInvocationInput", "documentation":"Contains information about the function that the agent predicts should be called.
" } }, "documentation":"Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The result from the API response from the action group invocation.
" }, "functionResult":{ "shape":"FunctionResult", "documentation":"The result from the function from the action group invocation.
" } }, "documentation":"A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
", "union":true }, "InvocationStep":{ "type":"structure", "required":[ "invocationId", "invocationStepId", "invocationStepTime", "payload", "sessionId" ], "members":{ "invocationId":{ "shape":"Uuid", "documentation":"The unique identifier (in UUID format) for the invocation that includes the invocation step.
" }, "invocationStepId":{ "shape":"Uuid", "documentation":"The unique identifier (in UUID format) for the invocation step.
" }, "invocationStepTime":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation step was created.
" }, "payload":{ "shape":"InvocationStepPayload", "documentation":"Payload content, such as text and images, for the invocation step.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier of the session containing the invocation step.
" } }, "documentation":"Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "InvocationStepPayload":{ "type":"structure", "members":{ "contentBlocks":{ "shape":"BedrockSessionContentBlocks", "documentation":"The content for the invocation step.
" } }, "documentation":"Payload content, such as text and images, for the invocation step.
", "union":true }, "InvocationStepSummaries":{ "type":"list", "member":{"shape":"InvocationStepSummary"} }, "InvocationStepSummary":{ "type":"structure", "required":[ "invocationId", "invocationStepId", "invocationStepTime", "sessionId" ], "members":{ "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" }, "invocationStepId":{ "shape":"Uuid", "documentation":"The unique identifier (in UUID format) for the invocation step.
" }, "invocationStepTime":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation step was created.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session associated with the invocation step.
" } }, "documentation":"Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "InvocationSummaries":{ "type":"list", "member":{"shape":"InvocationSummary"} }, "InvocationSummary":{ "type":"structure", "required":[ "createdAt", "invocationId", "sessionId" ], "members":{ "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation was created.
" }, "invocationId":{ "shape":"Uuid", "documentation":"A unique identifier for the invocation in UUID format.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session associated with the invocation.
" } }, "documentation":"Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "InvocationType":{ "type":"string", "enum":[ "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR" ] }, "InvokeAgentRequest":{ "type":"structure", "required":[ "agentAliasId", "agentId", "sessionId" ], "members":{ "agentAliasId":{ "shape":"AgentAliasId", "documentation":"The alias of the agent to use.
", "location":"uri", "locationName":"agentAliasId" }, "agentId":{ "shape":"AgentId", "documentation":"The unique identifier of the agent to use.
", "location":"uri", "locationName":"agentId" }, "bedrockModelConfigurations":{ "shape":"BedrockModelConfigurations", "documentation":"Model performance settings for the request.
" }, "enableTrace":{ "shape":"Boolean", "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" }, "endSession":{ "shape":"Boolean", "documentation":"Specifies whether to end the session with the agent or not.
" }, "inputText":{ "shape":"InputText", "documentation":"The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The unique identifier of the agent memory.
" }, "promptCreationConfigurations":{ "shape":"PromptCreationConfigurations", "documentation":"Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "location":"uri", "locationName":"sessionId" }, "sessionState":{ "shape":"SessionState", "documentation":"Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The ARN of the resource making the request.
", "location":"header", "locationName":"x-amz-source-arn" }, "streamingConfigurations":{ "shape":"StreamingConfigurations", "documentation":"Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
The agent's response to the user prompt.
" }, "contentType":{ "shape":"MimeType", "documentation":"The MIME type of the input data in the request. The default value is application/json.
The unique identifier of the agent memory.
", "location":"header", "locationName":"x-amz-bedrock-agent-memory-id" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
", "location":"header", "locationName":"x-amz-bedrock-agent-session-id" } }, "payload":"completion" }, "InvokeFlowRequest":{ "type":"structure", "required":[ "flowAliasIdentifier", "flowIdentifier", "inputs" ], "members":{ "enableTrace":{ "shape":"Boolean", "documentation":"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.
" }, "executionId":{ "shape":"FlowExecutionId", "documentation":"The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
", "location":"uri", "locationName":"flowIdentifier" }, "inputs":{ "shape":"FlowInputs", "documentation":"A list of objects, each containing information about an input into the flow.
" }, "modelPerformanceConfiguration":{ "shape":"ModelPerformanceConfiguration", "documentation":"Model performance settings for the request.
" } } }, "InvokeFlowResponse":{ "type":"structure", "required":["responseStream"], "members":{ "executionId":{ "shape":"FlowExecutionId", "documentation":"The unique identifier for the current flow execution.
", "location":"header", "locationName":"x-amz-bedrock-flow-execution-id" }, "responseStream":{ "shape":"FlowResponseStream", "documentation":"The output of the flow, returned as a stream. If there's an error, the error is returned.
" } }, "payload":"responseStream" }, "InvokeInlineAgentRequest":{ "type":"structure", "required":[ "foundationModel", "instruction", "sessionId" ], "members":{ "actionGroups":{ "shape":"AgentActionGroups", "documentation":"A list of action groups with each action group defining the action the inline agent needs to carry out.
" }, "agentCollaboration":{ "shape":"AgentCollaboration", "documentation":"Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" }, "agentName":{ "shape":"Name", "documentation":"The name for the agent.
" }, "bedrockModelConfigurations":{ "shape":"InlineBedrockModelConfigurations", "documentation":"Model settings for the request.
" }, "collaboratorConfigurations":{ "shape":"CollaboratorConfigurations", "documentation":"Settings for an inline agent collaborator called with InvokeInlineAgent.
" }, "collaborators":{ "shape":"Collaborators", "documentation":"List of collaborator inline agents.
" }, "customOrchestration":{ "shape":"CustomOrchestration", "documentation":"Contains details of the custom orchestration configured for the agent.
" }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" }, "enableTrace":{ "shape":"Boolean", "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" }, "endSession":{ "shape":"Boolean", "documentation":"Specifies whether to end the session with the inline agent or not.
" }, "foundationModel":{ "shape":"ModelIdentifier", "documentation":" The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.
The guardrails to assign to the inline agent.
" }, "idleSessionTTLInSeconds":{ "shape":"SessionTTL", "documentation":" The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
" }, "inlineSessionState":{ "shape":"InlineSessionState", "documentation":"Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The prompt text to send to the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The instructions that tell the inline agent what it should do and how it should interact with users.
" }, "knowledgeBases":{ "shape":"KnowledgeBases", "documentation":"Contains information of the knowledge bases to associate with.
" }, "orchestrationType":{ "shape":"OrchestrationType", "documentation":"Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" }, "promptCreationConfigurations":{ "shape":"PromptCreationConfigurations", "documentation":"Specifies parameters that control how the service populates the agent prompt for an InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "location":"uri", "locationName":"sessionId" }, "streamingConfigurations":{ "shape":"StreamingConfigurations", "documentation":"Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
The inline agent's response to the user prompt.
" }, "contentType":{ "shape":"MimeType", "documentation":"The MIME type of the input data in the request. The default value is application/json.
", "location":"header", "locationName":"x-amzn-bedrock-agent-content-type" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
", "location":"header", "locationName":"x-amz-bedrock-agent-session-id" } }, "payload":"completion" }, "KmsKeyArn":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" }, "KnowledgeBase":{ "type":"structure", "required":[ "description", "knowledgeBaseId" ], "members":{ "description":{ "shape":"ResourceDescription", "documentation":"The description of the knowledge base associated with the inline agent.
" }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier for a knowledge base associated with the inline agent.
" }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" } }, "documentation":"Details of the knowledge base associated withe inline agent.
" }, "KnowledgeBaseArn":{ "type":"string", "max":128, "min":0, "pattern":"^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" }, "KnowledgeBaseConfiguration":{ "type":"structure", "required":[ "knowledgeBaseId", "retrievalConfiguration" ], "members":{ "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier for a knowledge base attached to the agent.
" }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" } }, "documentation":"Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
" }, "KnowledgeBaseConfigurations":{ "type":"list", "member":{"shape":"KnowledgeBaseConfiguration"}, "min":1 }, "KnowledgeBaseId":{ "type":"string", "max":10, "min":0, "pattern":"^[0-9a-zA-Z]+$" }, "KnowledgeBaseLookupInput":{ "type":"structure", "members":{ "knowledgeBaseId":{ "shape":"TraceKnowledgeBaseId", "documentation":"The unique identifier of the knowledge base to look up.
" }, "text":{ "shape":"KnowledgeBaseLookupInputString", "documentation":"The query made to the knowledge base.
" } }, "documentation":"Contains details about the knowledge base to look up and the query to be made.
" }, "KnowledgeBaseLookupInputString":{ "type":"string", "sensitive":true }, "KnowledgeBaseLookupOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the knowledge base output.
" }, "retrievedReferences":{ "shape":"RetrievedReferences", "documentation":"Contains metadata about the sources cited for the generated response.
" } }, "documentation":"Contains details about the results from looking up the knowledge base.
" }, "KnowledgeBaseQuery":{ "type":"structure", "members":{ "image":{ "shape":"InputImage", "documentation":"An image to include in the knowledge base query for multimodal retrieval.
" }, "text":{ "shape":"KnowledgeBaseQueryTextString", "documentation":"The text of the query made to the knowledge base.
" }, "type":{ "shape":"KnowledgeBaseQueryType", "documentation":"The type of query being performed.
" } }, "documentation":"Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request – in the retrievalQuery field
Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
" } }, "documentation":"Contains configurations for knowledge base query. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the retrievalConfiguration field
RetrieveAndGenerate request – in the retrievalConfiguration field
Contains information about the content of the chunk.
" }, "location":{ "shape":"RetrievalResultLocation", "documentation":"Contains information about the location of the data source.
" }, "metadata":{ "shape":"RetrievalResultMetadata", "documentation":"Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" }, "score":{ "shape":"Double", "documentation":"The level of relevance of the result to the query.
" } }, "documentation":"Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response – in the retrievalResults field
Contains configurations for response generation based on the knowledge base query results.
" }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier of the knowledge base that is queried.
" }, "modelArn":{ "shape":"BedrockModelArn", "documentation":"The ARN of the foundation model or inference profile used to generate a response.
" }, "orchestrationConfiguration":{ "shape":"OrchestrationConfiguration", "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" }, "retrievalConfiguration":{ "shape":"KnowledgeBaseRetrievalConfiguration", "documentation":"Contains configurations for how to retrieve and return the knowledge base query.
" } }, "documentation":"Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" }, "implicitFilterConfiguration":{ "shape":"ImplicitFilterConfiguration", "documentation":"Settings for implicit filtering.
" }, "numberOfResults":{ "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", "documentation":"The number of source chunks to retrieve.
", "box":true }, "overrideSearchType":{ "shape":"SearchType", "documentation":"By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" } }, "documentation":"Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
The unique identifier of the flow execution.
", "location":"uri", "locationName":"executionIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
", "location":"uri", "locationName":"flowIdentifier" }, "maxResults":{ "shape":"MaxResults", "documentation":"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.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to retrieve the next set of results. This value is returned in the response if more results are available.
", "location":"querystring", "locationName":"nextToken" } } }, "ListFlowExecutionEventsResponse":{ "type":"structure", "required":["flowExecutionEvents"], "members":{ "flowExecutionEvents":{ "shape":"FlowExecutionEvents", "documentation":"A list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to retrieve the next set of results. This value is returned if more results are available.
" } } }, "ListFlowExecutionsRequest":{ "type":"structure", "required":["flowIdentifier"], "members":{ "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias to list executions for.
", "location":"querystring", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow to list executions for.
", "location":"uri", "locationName":"flowIdentifier" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
A token to retrieve the next set of results. This value is returned in the response if more results are available.
", "location":"querystring", "locationName":"nextToken" } } }, "ListFlowExecutionsResponse":{ "type":"structure", "required":["flowExecutionSummaries"], "members":{ "flowExecutionSummaries":{ "shape":"FlowExecutionSummaries", "documentation":"A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to retrieve the next set of results. This value is returned if more results are available.
" } } }, "ListInvocationStepsRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "invocationIdentifier":{ "shape":"InvocationIdentifier", "documentation":"The unique identifier (in UUID format) for the invocation to list invocation steps for.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The unique identifier for the session associated with the invocation steps. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
A list of invocation summaries associated with the session.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A list of summaries for each session in your Amazon Web Services account.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"TaggableResourcesArn", "documentation":"The Amazon Resource Name (ARN) of the resource for which to list tags.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"The key-value pairs for the tags associated with the resource.
" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "documentation":"Max Results.
", "box":true, "max":1000, "min":1 }, "MaxTokens":{ "type":"integer", "box":true, "max":65536, "min":0 }, "MaximumLength":{ "type":"integer", "box":true, "max":8192, "min":0 }, "Memories":{ "type":"list", "member":{"shape":"Memory"} }, "Memory":{ "type":"structure", "members":{ "sessionSummary":{ "shape":"MemorySessionSummary", "documentation":"Contains summary of a session.
" } }, "documentation":"Contains sessions summaries.
", "union":true }, "MemoryId":{ "type":"string", "max":100, "min":2, "pattern":"^[0-9a-zA-Z._:-]+$" }, "MemorySessionSummary":{ "type":"structure", "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The unique identifier of the memory where the session summary is stored.
" }, "sessionExpiryTime":{ "shape":"DateTimestamp", "documentation":"The time when the memory duration for the session is set to end.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier for this session.
" }, "sessionStartTime":{ "shape":"DateTimestamp", "documentation":"The start time for this session.
" }, "summaryText":{ "shape":"SummaryText", "documentation":"The summarized text for this session.
" } }, "documentation":"Contains details of a session summary.
" }, "MemoryType":{ "type":"string", "enum":["SESSION_SUMMARY"] }, "Message":{ "type":"structure", "required":[ "content", "role" ], "members":{ "content":{ "shape":"ContentBlocks", "documentation":"The message's content.
" }, "role":{ "shape":"ConversationRole", "documentation":"The message's role.
" } }, "documentation":"Details about a message.
" }, "Messages":{ "type":"list", "member":{"shape":"Message"} }, "Metadata":{ "type":"structure", "members":{ "clientRequestId":{ "shape":"String", "documentation":"A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" }, "endTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"In the final response, endTime is the end time of the agent invocation operation.
The total time it took for the agent to complete execution. This field is only set for the final response.
" }, "startTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"In the final response, startTime is the start time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" }, "usage":{ "shape":"Usage", "documentation":"Specific to model invocation and contains details about the usage of a foundation model.
" } }, "documentation":"Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
", "sensitive":true }, "MetadataAttributeSchema":{ "type":"structure", "required":[ "description", "key", "type" ], "members":{ "description":{ "shape":"MetadataAttributeSchemaDescriptionString", "documentation":"The attribute's description.
" }, "key":{ "shape":"MetadataAttributeSchemaKeyString", "documentation":"The attribute's key.
" }, "type":{ "shape":"AttributeType", "documentation":"The attribute's type.
" } }, "documentation":"Details about a metadata attribute.
", "sensitive":true }, "MetadataAttributeSchemaDescriptionString":{ "type":"string", "max":1024, "min":1, "pattern":"^[\\s\\S]+$" }, "MetadataAttributeSchemaKeyString":{ "type":"string", "max":256, "min":1, "pattern":"^[\\s\\S]+$" }, "MetadataAttributeSchemaList":{ "type":"list", "member":{"shape":"MetadataAttributeSchema"}, "max":25, "min":1 }, "MetadataConfigurationForReranking":{ "type":"structure", "required":["selectionMode"], "members":{ "selectionMode":{ "shape":"RerankingMetadataSelectionMode", "documentation":"Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.
Contains configurations for the metadata fields to include or exclude when considering reranking.
" } }, "documentation":"Contains configurations for the metadata to use in reranking.
" }, "MimeType":{"type":"string"}, "ModelIdentifier":{ "type":"string", "max":2048, "min":1, "pattern":"(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$" }, "ModelInvocationInput":{ "type":"structure", "members":{ "foundationModel":{ "shape":"ModelIdentifier", "documentation":"The identifier of a foundation model.
" }, "inferenceConfiguration":{ "shape":"InferenceConfiguration", "documentation":"Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
" }, "overrideLambda":{ "shape":"LambdaArn", "documentation":"The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" }, "parserMode":{ "shape":"CreationMode", "documentation":"Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
The text that prompted the agent at this step.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" }, "type":{ "shape":"PromptType", "documentation":"The step in the agent sequence.
" } }, "documentation":"The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "ModelPerformanceConfiguration":{ "type":"structure", "members":{ "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" } }, "documentation":"The performance configuration for a model called with InvokeFlow.
" }, "Name":{ "type":"string", "pattern":"^([0-9a-zA-Z][_-]?){1,100}$", "sensitive":true }, "NextToken":{ "type":"string", "max":2048, "min":1, "pattern":"^\\S*$" }, "NodeActionEvent":{ "type":"structure", "required":[ "nodeName", "operationName", "requestId", "serviceName", "timestamp" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that called the operation.
" }, "operationName":{ "shape":"String", "documentation":"The name of the operation that the node called.
" }, "operationRequest":{ "shape":"Document", "documentation":"The request payload sent to the downstream service.
" }, "operationResponse":{ "shape":"Document", "documentation":"The response payload received from the downstream service.
" }, "requestId":{ "shape":"String", "documentation":"The ID of the request that the node made to the operation.
" }, "serviceName":{ "shape":"String", "documentation":"The name of the service that the node called.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the operation was called.
" } }, "documentation":"Contains information about an action (operation) called by a node during execution.
", "sensitive":true }, "NodeDependencyEvent":{ "type":"structure", "required":[ "nodeName", "timestamp", "traceElements" ], "members":{ "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that generated the dependency trace.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The date and time that the dependency trace was generated.
" }, "traceElements":{ "shape":"NodeTraceElements", "documentation":"The trace elements containing detailed information about the node execution.
" } }, "documentation":"Contains information about an internal trace of a specific node during execution.
", "sensitive":true }, "NodeErrorCode":{ "type":"string", "enum":[ "VALIDATION", "DEPENDENCY_FAILED", "BAD_GATEWAY", "INTERNAL_SERVER" ] }, "NodeExecutionContent":{ "type":"structure", "members":{ "document":{ "shape":"Document", "documentation":"The document content of the field, which can contain text or structured data.
" } }, "documentation":"Contains the content of a flow node's input or output field for a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The error code that identifies the type of failure that occurred at the node.
" }, "errorMessage":{ "shape":"String", "documentation":"A descriptive message that provides details about the node failure.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node where the failure occurred.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the node failure occurred.
" } }, "documentation":"Contains information about a failure that occurred at a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the node.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that received the inputs.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the inputs were provided to the node.
" } }, "documentation":"Contains information about the inputs provided to a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The index position of this item in the execution chain.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node in the execution chain.
" }, "type":{ "shape":"FlowControlNodeType", "documentation":"The type of execution chain item. Supported values are Iterator and Loop.
" } }, "documentation":"Represents an item in the execution chain for node input tracking.
" }, "NodeInputField":{ "type":"structure", "required":[ "content", "name" ], "members":{ "category":{ "shape":"FlowNodeInputCategory", "documentation":"The category of the input field.
" }, "content":{ "shape":"NodeExecutionContent", "documentation":"The content of the input field, which can contain text or structured data.
" }, "executionChain":{ "shape":"NodeInputExecutionChain", "documentation":"The execution path through nested nodes like iterators and loops.
" }, "name":{ "shape":"NodeInputName", "documentation":"The name of the input field as defined in the node's input schema.
" }, "source":{ "shape":"NodeInputSource", "documentation":"The source node that provides input data to this field.
" }, "type":{ "shape":"FlowNodeIODataType", "documentation":"The data type of the input field for compatibility validation.
" } }, "documentation":"Represents an input field provided to a node during a flow execution.
", "sensitive":true }, "NodeInputFields":{ "type":"list", "member":{"shape":"NodeInputField"}, "max":5, "min":1 }, "NodeInputName":{ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" }, "NodeInputSource":{ "type":"structure", "required":[ "expression", "nodeName", "outputFieldName" ], "members":{ "expression":{ "shape":"FlowNodeInputExpression", "documentation":"The expression used to extract data from the source.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the source node that provides the input data.
" }, "outputFieldName":{ "shape":"FlowNodeOutputName", "documentation":"The name of the output field from the source node.
" } }, "documentation":"Represents the source of input data for a node field.
" }, "NodeName":{ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" }, "NodeOutputEvent":{ "type":"structure", "required":[ "fields", "nodeName", "timestamp" ], "members":{ "fields":{ "shape":"NodeOutputFields", "documentation":"A list of output fields produced by the node.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the node that produced the outputs.
" }, "timestamp":{ "shape":"DateTimestamp", "documentation":"The timestamp when the outputs were produced by the node.
" } }, "documentation":"Contains information about the outputs produced by a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The content of the output field, which can contain text or structured data.
" }, "name":{ "shape":"NodeOutputName", "documentation":"The name of the output field as defined in the node's output schema.
" }, "next":{ "shape":"NodeOutputNextList", "documentation":"The next node that receives output data from this field.
" }, "type":{ "shape":"FlowNodeIODataType", "documentation":"The data type of the output field for compatibility validation.
" } }, "documentation":"Represents an output field produced by a node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the input field in the next node that receives the data.
" }, "nodeName":{ "shape":"NodeName", "documentation":"The name of the next node that receives the output data.
" } }, "documentation":"Represents the next node that receives output data.
", "sensitive":true }, "NodeOutputNextList":{ "type":"list", "member":{"shape":"NodeOutputNext"} }, "NodeTraceElements":{ "type":"structure", "members":{ "agentTraces":{ "shape":"AgentTraces", "documentation":"Agent trace information for the node execution.
" } }, "documentation":"Contains trace elements for node execution tracking.
", "sensitive":true, "union":true }, "NodeType":{ "type":"string", "enum":[ "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode" ] }, "NonBlankString":{ "type":"string", "pattern":"^[\\s\\S]*$" }, "Observation":{ "type":"structure", "members":{ "actionGroupInvocationOutput":{ "shape":"ActionGroupInvocationOutput", "documentation":"Contains the JSON-formatted string returned by the API invoked by the action group.
" }, "agentCollaboratorInvocationOutput":{ "shape":"AgentCollaboratorInvocationOutput", "documentation":"A collaborator's invocation output.
" }, "codeInterpreterInvocationOutput":{ "shape":"CodeInterpreterInvocationOutput", "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" }, "finalResponse":{ "shape":"FinalResponse", "documentation":"Contains details about the response to the user.
" }, "knowledgeBaseLookupOutput":{ "shape":"KnowledgeBaseLookupOutput", "documentation":"Contains details about the results from looking up the knowledge base.
" }, "repromptResponse":{ "shape":"RepromptResponse", "documentation":"Contains details about the response to reprompt the input.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" }, "type":{ "shape":"Type", "documentation":"Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP – The agent returns the result of an action group.
KNOWLEDGE_BASE – The agent returns information from a knowledge base.
FINISH – The agent returns a final response to the user with no follow-up.
ASK_USER – The agent asks the user a question.
REPROMPT – The agent prompts the user again for the same information.
Contains the result or output of an action group or knowledge base, or the response to the user.
", "sensitive":true }, "OptimizePromptRequest":{ "type":"structure", "required":[ "input", "targetModelId" ], "members":{ "input":{ "shape":"InputPrompt", "documentation":"Contains the prompt to optimize.
" }, "targetModelId":{ "shape":"OptimizePromptRequestTargetModelIdString", "documentation":"The unique identifier of the model that you want to optimize the prompt for.
" } } }, "OptimizePromptRequestTargetModelIdString":{ "type":"string", "max":2048, "min":1, "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" }, "OptimizePromptResponse":{ "type":"structure", "required":["optimizedPrompt"], "members":{ "optimizedPrompt":{ "shape":"OptimizedPromptStream", "documentation":"The prompt after being optimized for the task.
" } }, "payload":"optimizedPrompt" }, "OptimizedPrompt":{ "type":"structure", "members":{ "textPrompt":{ "shape":"TextPrompt", "documentation":"Contains information about the text in the prompt that was optimized.
" } }, "documentation":"Contains information about the optimized prompt.
", "union":true }, "OptimizedPromptEvent":{ "type":"structure", "members":{ "optimizedPrompt":{ "shape":"OptimizedPrompt", "documentation":"Contains information about the optimized prompt.
" } }, "documentation":"An event in which the prompt was optimized.
", "event":true, "sensitive":true }, "OptimizedPromptStream":{ "type":"structure", "members":{ "accessDeniedException":{ "shape":"AccessDeniedException", "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, "analyzePromptEvent":{ "shape":"AnalyzePromptEvent", "documentation":"An event in which the prompt was analyzed in preparation for optimization.
" }, "badGatewayException":{ "shape":"BadGatewayException", "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" }, "dependencyFailedException":{ "shape":"DependencyFailedException", "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, "optimizedPromptEvent":{ "shape":"OptimizedPromptEvent", "documentation":"An event in which the prompt was optimized.
" }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.
" }, "validationException":{ "shape":"ValidationException", "documentation":"Input validation failed. Check your request parameters and retry the request.
" } }, "documentation":"The stream containing events in the prompt optimization process.
", "eventstream":true }, "OrchestrationConfiguration":{ "type":"structure", "members":{ "additionalModelRequestFields":{ "shape":"AdditionalModelRequestFields", "documentation":"Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
" }, "inferenceConfig":{ "shape":"InferenceConfig", "documentation":"Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" }, "performanceConfig":{ "shape":"PerformanceConfiguration", "documentation":"The latency configuration for the model.
" }, "promptTemplate":{ "shape":"PromptTemplate", "documentation":"Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Settings for how the model processes the prompt prior to retrieval and generation.
" }, "OrchestrationExecutor":{ "type":"structure", "members":{ "lambda":{ "shape":"LambdaArn", "documentation":"The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "documentation":"The structure of the executor invoking the actions in custom orchestration.
", "union":true }, "OrchestrationModelInvocationOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the foundation model output from the orchestration step.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"Contains details of the raw response from the foundation model output.
" }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the orchestration step.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the orchestration step.
", "sensitive":true }, "OrchestrationTrace":{ "type":"structure", "members":{ "invocationInput":{ "shape":"InvocationInput", "documentation":"Contains information pertaining to the action group or knowledge base that is being invoked.
" }, "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
Contains information pertaining to the output from the foundation model that is being invoked.
" }, "observation":{ "shape":"Observation", "documentation":"Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" }, "rationale":{ "shape":"Rationale", "documentation":"Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
" } }, "documentation":"Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
", "sensitive":true, "union":true }, "OrchestrationType":{ "type":"string", "enum":[ "DEFAULT", "CUSTOM_ORCHESTRATION" ] }, "OutputFile":{ "type":"structure", "members":{ "bytes":{ "shape":"FileBody", "documentation":"The byte count of files that contains response from code interpreter.
" }, "name":{ "shape":"String", "documentation":"The name of the file containing response from code interpreter.
" }, "type":{ "shape":"MimeType", "documentation":"The type of file that contains response from the code interpreter.
" } }, "documentation":"Contains details of the response from code interpreter.
", "sensitive":true }, "OutputFiles":{ "type":"list", "member":{"shape":"OutputFile"}, "max":5, "min":0 }, "OutputString":{ "type":"string", "sensitive":true }, "Parameter":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"The name of the parameter.
" }, "type":{ "shape":"String", "documentation":"The type of the parameter.
" }, "value":{ "shape":"String", "documentation":"The value of the parameter.
" } }, "documentation":"A parameter for the API request or function.
" }, "ParameterDescription":{ "type":"string", "max":500, "min":1 }, "ParameterDetail":{ "type":"structure", "required":["type"], "members":{ "description":{ "shape":"ParameterDescription", "documentation":"A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" }, "required":{ "shape":"Boolean", "documentation":"Whether the parameter is required for the agent to complete the function for action group invocation.
" }, "type":{ "shape":"ParameterType", "documentation":"The data type of the parameter.
" } }, "documentation":"Contains details about a parameter in a function for an action group.
" }, "ParameterList":{ "type":"list", "member":{"shape":"Parameter"} }, "ParameterMap":{ "type":"map", "key":{"shape":"ParameterName"}, "value":{"shape":"ParameterDetail"} }, "ParameterName":{ "type":"string", "pattern":"^([0-9a-zA-Z][_-]?){1,100}$" }, "ParameterType":{ "type":"string", "enum":[ "string", "number", "integer", "boolean", "array" ] }, "Parameters":{ "type":"list", "member":{"shape":"Parameter"} }, "PartBody":{ "type":"blob", "max":1000000, "min":0, "sensitive":true }, "Payload":{ "type":"string", "sensitive":true }, "PayloadPart":{ "type":"structure", "members":{ "attribution":{ "shape":"Attribution", "documentation":"Contains citations for a part of an agent response.
" }, "bytes":{ "shape":"PartBody", "documentation":"A part of the agent response in bytes.
" } }, "documentation":"Contains a part of an agent response and citations for it.
", "event":true, "sensitive":true }, "PayloadType":{ "type":"string", "enum":[ "TEXT", "RETURN_CONTROL" ] }, "PerformanceConfigLatency":{ "type":"string", "enum":[ "standard", "optimized" ] }, "PerformanceConfiguration":{ "type":"structure", "members":{ "latency":{ "shape":"PerformanceConfigLatency", "documentation":"To use a latency-optimized version of the model, set to optimized.
Performance settings for a model.
" }, "PostProcessingModelInvocationOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the foundation model output from the post-processing step.
" }, "parsedResponse":{ "shape":"PostProcessingParsedResponse", "documentation":"Details about the response from the Lambda parsing of the output of the post-processing step.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"Details of the raw response from the foundation model output.
" }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the post-processing step.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the post-processing step.
", "sensitive":true }, "PostProcessingParsedResponse":{ "type":"structure", "members":{ "text":{ "shape":"OutputString", "documentation":"The text returned by the parser.
" } }, "documentation":"Details about the response from the Lambda parsing of the output from the post-processing step.
", "sensitive":true }, "PostProcessingTrace":{ "type":"structure", "members":{ "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the post-processing step.
" } }, "documentation":"Details about the post-processing step, in which the agent shapes the response.
", "sensitive":true, "union":true }, "PreProcessingModelInvocationOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"Contains information about the foundation model output from the pre-processing step.
" }, "parsedResponse":{ "shape":"PreProcessingParsedResponse", "documentation":"Details about the response from the Lambda parsing of the output of the pre-processing step.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"Details of the raw response from the foundation model output.
" }, "reasoningContent":{ "shape":"ReasoningContentBlock", "documentation":"Contains content about the reasoning that the model made during the pre-processing step.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" } }, "documentation":"The foundation model output from the pre-processing step.
", "sensitive":true }, "PreProcessingParsedResponse":{ "type":"structure", "members":{ "isValid":{ "shape":"Boolean", "documentation":"Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
" } }, "documentation":"Details about the response from the Lambda parsing of the output from the pre-processing step.
", "sensitive":true }, "PreProcessingTrace":{ "type":"structure", "members":{ "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the pre-processing step.
" } }, "documentation":"Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
", "sensitive":true, "union":true }, "PromptConfiguration":{ "type":"structure", "members":{ "additionalModelRequestFields":{ "shape":"Document", "documentation":"If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" }, "basePromptTemplate":{ "shape":"BasePromptTemplate", "documentation":"Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" }, "foundationModel":{ "shape":"ModelIdentifier", "documentation":"The foundation model to use.
" }, "inferenceConfiguration":{ "shape":"InferenceConfiguration", "documentation":"Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
The step in the agent sequence that this prompt configuration applies to.
" } }, "documentation":"Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" }, "PromptConfigurations":{ "type":"list", "member":{"shape":"PromptConfiguration"}, "max":10, "min":0 }, "PromptCreationConfigurations":{ "type":"structure", "members":{ "excludePreviousThinkingSteps":{ "shape":"Boolean", "documentation":"If true, the service removes any content between <thinking> tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is false.
The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.
" } }, "documentation":"Specifies parameters that control how the service populates the agent prompt for an InvokeAgent or InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" } }, "documentation":"Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", "sensitive":true }, "PromptSessionAttributesMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "PromptState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "PromptTemplate":{ "type":"structure", "members":{ "textPromptTemplate":{ "shape":"TextPromptTemplate", "documentation":"The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
" } }, "documentation":"Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter field
A list of parameters in the request body.
" } }, "documentation":"Contains the parameters in the request body.
" }, "PutInvocationStepRequest":{ "type":"structure", "required":[ "invocationIdentifier", "invocationStepTime", "payload", "sessionIdentifier" ], "members":{ "invocationIdentifier":{ "shape":"InvocationIdentifier", "documentation":"The unique identifier (in UUID format) of the invocation to add the invocation step to.
" }, "invocationStepId":{ "shape":"Uuid", "documentation":"The unique identifier of the invocation step in UUID format.
" }, "invocationStepTime":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the invocation step occurred.
" }, "payload":{ "shape":"InvocationStepPayload", "documentation":"The payload for the invocation step, including text and images for the interaction.
" }, "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier of the invocation step in UUID format.
" } } }, "QueryGenerationInput":{ "type":"structure", "required":[ "text", "type" ], "members":{ "text":{ "shape":"QueryGenerationInputTextString", "documentation":"The text of the query.
" }, "type":{ "shape":"InputQueryType", "documentation":"The type of the query.
" } }, "documentation":"Contains information about a natural language query to transform into SQL.
", "sensitive":true }, "QueryGenerationInputTextString":{ "type":"string", "max":20000, "min":1 }, "QueryTransformationConfiguration":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"QueryTransformationType", "documentation":"The type of transformation to apply to the prompt.
" } }, "documentation":"To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The reasoning or thought process of the agent, based on the input.
" }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace step.
" } }, "documentation":"Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
", "sensitive":true }, "RationaleString":{ "type":"string", "sensitive":true }, "RawResponse":{ "type":"structure", "members":{ "content":{ "shape":"String", "documentation":"The foundation model's raw output content.
" } }, "documentation":"Contains the raw output from the foundation model.
", "sensitive":true }, "ReasoningContentBlock":{ "type":"structure", "members":{ "reasoningText":{ "shape":"ReasoningTextBlock", "documentation":"Contains information about the reasoning that the model used to return the content in the content block.
" }, "redactedContent":{ "shape":"Blob", "documentation":"The content in the reasoning that was encrypted by the model provider for trust and safety reasons.
" } }, "documentation":"Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
", "sensitive":true, "union":true }, "ReasoningTextBlock":{ "type":"structure", "required":["text"], "members":{ "signature":{ "shape":"String", "documentation":"A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Text describing the reasoning that the model used to return the content in the content block.
" } }, "documentation":"Contains information about the reasoning that the model used to return the content in the content block.
", "sensitive":true }, "RelayConversationHistory":{ "type":"string", "enum":[ "TO_COLLABORATOR", "DISABLED" ] }, "RepromptResponse":{ "type":"structure", "members":{ "source":{ "shape":"Source", "documentation":"Specifies what output is prompting the agent to reprompt the input.
" }, "text":{ "shape":"String", "documentation":"The text reprompting the input.
" } }, "documentation":"Contains details about the agent's response to reprompt the input.
", "sensitive":true }, "RequestBody":{ "type":"structure", "members":{ "content":{ "shape":"ContentMap", "documentation":"The content in the request body.
" } }, "documentation":"The parameters in the API request body.
" }, "RequireConfirmation":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "RerankDocument":{ "type":"structure", "required":["type"], "members":{ "jsonDocument":{ "shape":"Document", "documentation":"Contains a JSON document to rerank.
" }, "textDocument":{ "shape":"RerankTextDocument", "documentation":"Contains information about a text document to rerank.
" }, "type":{ "shape":"RerankDocumentType", "documentation":"The type of document to rerank.
" } }, "documentation":"Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
Contains information about a text query.
" }, "type":{ "shape":"RerankQueryContentType", "documentation":"The type of the query.
" } }, "documentation":"Contains information about a query to submit to the reranker model.
", "sensitive":true }, "RerankQueryContentType":{ "type":"string", "enum":["TEXT"] }, "RerankRequest":{ "type":"structure", "required":[ "queries", "rerankingConfiguration", "sources" ], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.
An array of objects, each of which contains information about a query to submit to the reranker model.
" }, "rerankingConfiguration":{ "shape":"RerankingConfiguration", "documentation":"Contains configurations for reranking.
" }, "sources":{ "shape":"RerankSourcesList", "documentation":"An array of objects, each of which contains information about the sources to rerank.
" } } }, "RerankResponse":{ "type":"structure", "required":["results"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.
An array of objects, each of which contains information about the results of reranking.
" } } }, "RerankResult":{ "type":"structure", "required":[ "index", "relevanceScore" ], "members":{ "document":{ "shape":"RerankDocument", "documentation":"Contains information about the document.
" }, "index":{ "shape":"RerankResultIndexInteger", "documentation":"The original index of the document from the input sources array.
" }, "relevanceScore":{ "shape":"Float", "documentation":"The relevance score of the document.
" } }, "documentation":"Contains information about a document that was reranked.
" }, "RerankResultIndexInteger":{ "type":"integer", "box":true, "max":1000, "min":0 }, "RerankResultsList":{ "type":"list", "member":{"shape":"RerankResult"} }, "RerankSource":{ "type":"structure", "required":[ "inlineDocumentSource", "type" ], "members":{ "inlineDocumentSource":{ "shape":"RerankDocument", "documentation":"Contains an inline definition of a source for reranking.
" }, "type":{ "shape":"RerankSourceType", "documentation":"The type of the source.
" } }, "documentation":"Contains information about a source for reranking.
", "sensitive":true }, "RerankSourceType":{ "type":"string", "enum":["INLINE"] }, "RerankSourcesList":{ "type":"list", "member":{"shape":"RerankSource"}, "max":1000, "min":1, "sensitive":true }, "RerankTextDocument":{ "type":"structure", "members":{ "text":{ "shape":"RerankTextDocumentTextString", "documentation":"The text of the document.
" } }, "documentation":"Contains information about a text document to rerank.
", "sensitive":true }, "RerankTextDocumentTextString":{ "type":"string", "max":32000, "min":1 }, "RerankingConfiguration":{ "type":"structure", "required":[ "bedrockRerankingConfiguration", "type" ], "members":{ "bedrockRerankingConfiguration":{ "shape":"BedrockRerankingConfiguration", "documentation":"Contains configurations for an Amazon Bedrock reranker.
" }, "type":{ "shape":"RerankingConfigurationType", "documentation":"The type of reranker that the configurations apply to.
" } }, "documentation":"Contains configurations for reranking.
" }, "RerankingConfigurationType":{ "type":"string", "enum":["BEDROCK_RERANKING_MODEL"] }, "RerankingMetadataSelectionMode":{ "type":"string", "enum":[ "SELECTIVE", "ALL" ] }, "RerankingMetadataSelectiveModeConfiguration":{ "type":"structure", "members":{ "fieldsToExclude":{ "shape":"FieldsForReranking", "documentation":"An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
" }, "fieldsToInclude":{ "shape":"FieldsForReranking", "documentation":"An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
" } }, "documentation":"Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
/ @documentation("Description of the using the resource.")
", "max":200, "min":1, "sensitive":true }, "ResourceName":{ "type":"string", "pattern":"^([0-9a-zA-Z][_-]?){1,100}$", "sensitive":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResponseBody":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ContentBody"} }, "ResponseState":{ "type":"string", "enum":[ "FAILURE", "REPROMPT" ] }, "ResponseStream":{ "type":"structure", "members":{ "accessDeniedException":{ "shape":"AccessDeniedException", "documentation":"The request is denied because of missing access permissions. Check your permissions and retry your request.
" }, "badGatewayException":{ "shape":"BadGatewayException", "documentation":"There was an issue with a dependency due to a server issue. Retry your request.
" }, "chunk":{ "shape":"PayloadPart", "documentation":"Contains a part of an agent response and citations for it.
" }, "conflictException":{ "shape":"ConflictException", "documentation":"There was a conflict performing an operation. Resolve the conflict and retry your request.
" }, "dependencyFailedException":{ "shape":"DependencyFailedException", "documentation":"There was an issue with a dependency. Check the resource configurations and retry the request.
" }, "files":{ "shape":"FilePart", "documentation":"Contains intermediate response for code interpreter if any files have been generated.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, "modelNotReadyException":{ "shape":"ModelNotReadyException", "documentation":"The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" }, "returnControl":{ "shape":"ReturnControlPayload", "documentation":"Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"The number of requests exceeds the service quota. Resubmit your request later.
" }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"The number of requests exceeds the limit. Resubmit your request later.
" }, "trace":{ "shape":"TracePart", "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" }, "validationException":{ "shape":"ValidationException", "documentation":"Input validation failed. Check your request parameters and retry the request.
" } }, "documentation":"The response from invoking the agent and associated citations and trace information.
", "eventstream":true }, "RetrievalFilter":{ "type":"structure", "members":{ "andAll":{ "shape":"RetrievalFilterList", "documentation":"Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" }, "equals":{ "shape":"FilterAttribute", "documentation":"Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
\"equals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
\"greaterThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
\"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
\"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
\"lessThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
\"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example [\"dog\", \"cat\"]).
\"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
\"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
\"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
" }, "startsWith":{ "shape":"FilterAttribute", "documentation":"Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
\"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
\"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example [\"dog\", \"cat\"]).
\"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request – in the filter field
RetrieveAndGenerate request – in the filter field
The Confluence host URL for the data source location.
" } }, "documentation":"The Confluence data source location.
" }, "RetrievalResultContent":{ "type":"structure", "members":{ "audio":{ "shape":"AudioSegment", "documentation":"Audio segment information when the retrieval result contains audio content.
" }, "byteContent":{ "shape":"String", "documentation":"A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.
Specifies information about the rows with the cells to return in retrieval.
" }, "text":{ "shape":"String", "documentation":"The cited text from the data source.
" }, "type":{ "shape":"RetrievalResultContentType", "documentation":"The type of content in the retrieval result.
" }, "video":{ "shape":"VideoSegment", "documentation":"Video segment information when the retrieval result contains video content.
" } }, "documentation":"Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
The name of the column.
" }, "columnValue":{ "shape":"String", "documentation":"The value in the column.
" }, "type":{ "shape":"RetrievalResultContentColumnType", "documentation":"The data type of the value.
" } }, "documentation":"Contains information about a column with a cell to return in retrieval.
", "sensitive":true }, "RetrievalResultContentColumnType":{ "type":"string", "enum":[ "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING" ] }, "RetrievalResultContentRow":{ "type":"list", "member":{"shape":"RetrievalResultContentColumn"}, "sensitive":true }, "RetrievalResultContentType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "ROW", "AUDIO", "VIDEO" ] }, "RetrievalResultCustomDocumentLocation":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The ID of the document.
" } }, "documentation":"Contains information about the location of a document in a custom data source.
" }, "RetrievalResultKendraDocumentLocation":{ "type":"structure", "members":{ "uri":{ "shape":"String", "documentation":"The document's uri.
" } }, "documentation":"The location of a result in Amazon Kendra.
" }, "RetrievalResultLocation":{ "type":"structure", "required":["type"], "members":{ "confluenceLocation":{ "shape":"RetrievalResultConfluenceLocation", "documentation":"The Confluence data source location.
" }, "customDocumentLocation":{ "shape":"RetrievalResultCustomDocumentLocation", "documentation":"Specifies the location of a document in a custom data source.
" }, "kendraDocumentLocation":{ "shape":"RetrievalResultKendraDocumentLocation", "documentation":"The location of a document in Amazon Kendra.
" }, "s3Location":{ "shape":"RetrievalResultS3Location", "documentation":"The S3 data source location.
" }, "salesforceLocation":{ "shape":"RetrievalResultSalesforceLocation", "documentation":"The Salesforce data source location.
" }, "sharePointLocation":{ "shape":"RetrievalResultSharePointLocation", "documentation":"The SharePoint data source location.
" }, "sqlLocation":{ "shape":"RetrievalResultSqlLocation", "documentation":"Specifies information about the SQL query used to retrieve the result.
" }, "type":{ "shape":"RetrievalResultLocationType", "documentation":"The type of data source location.
" }, "webLocation":{ "shape":"RetrievalResultWebLocation", "documentation":"The web URL/URLs data source location.
" } }, "documentation":"Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the location field
The S3 URI for the data source location.
" } }, "documentation":"The S3 data source location.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
The Salesforce host URL for the data source location.
" } }, "documentation":"The Salesforce data source location.
" }, "RetrievalResultSharePointLocation":{ "type":"structure", "members":{ "url":{ "shape":"String", "documentation":"The SharePoint site URL for the data source location.
" } }, "documentation":"The SharePoint data source location.
" }, "RetrievalResultSqlLocation":{ "type":"structure", "members":{ "query":{ "shape":"String", "documentation":"The SQL query used to retrieve the result.
" } }, "documentation":"Contains information about the SQL query used to retrieve the result.
" }, "RetrievalResultWebLocation":{ "type":"structure", "members":{ "url":{ "shape":"String", "documentation":"The web URL/URLs for the data source location.
" } }, "documentation":"The web URL/URLs data source location.
" }, "RetrieveAndGenerateConfiguration":{ "type":"structure", "required":["type"], "members":{ "externalSourcesConfiguration":{ "shape":"ExternalSourcesRetrieveAndGenerateConfiguration", "documentation":"The configuration for the external source wrapper object in the retrieveAndGenerate function.
Contains details about the knowledge base for retrieving information and generating responses.
" }, "type":{ "shape":"RetrieveAndGenerateType", "documentation":"The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
The query made to the knowledge base, in characters.
" } }, "documentation":"Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the input field
The response generated from querying the knowledge base.
" } }, "documentation":"Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the output field
A text response.
" } }, "documentation":"A retrieve and generate output event.
", "event":true, "sensitive":true }, "RetrieveAndGenerateRequest":{ "type":"structure", "required":["input"], "members":{ "input":{ "shape":"RetrieveAndGenerateInput", "documentation":"Contains the query to be made to the knowledge base.
" }, "retrieveAndGenerateConfiguration":{ "shape":"RetrieveAndGenerateConfiguration", "documentation":"Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" }, "sessionConfiguration":{ "shape":"RetrieveAndGenerateSessionConfiguration", "documentation":"Contains details about the session with the knowledge base.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
" }, "guardrailAction":{ "shape":"GuadrailAction", "documentation":"Specifies if there is a guardrail intervention in the response.
" }, "output":{ "shape":"RetrieveAndGenerateOutput", "documentation":"Contains the response generated from querying the knowledge base.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
The ARN of the KMS key encrypting the session.
" } }, "documentation":"Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the sessionConfiguration field
Contains the query to be made to the knowledge base.
" }, "retrieveAndGenerateConfiguration":{ "shape":"RetrieveAndGenerateConfiguration", "documentation":"Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" }, "sessionConfiguration":{ "shape":"RetrieveAndGenerateSessionConfiguration", "documentation":"Contains details about the session with the knowledge base.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
The session ID.
", "location":"header", "locationName":"x-amzn-bedrock-knowledge-base-session-id" }, "stream":{ "shape":"RetrieveAndGenerateStreamResponseOutput", "documentation":"A stream of events from the model.
" } }, "payload":"stream" }, "RetrieveAndGenerateStreamResponseOutput":{ "type":"structure", "members":{ "accessDeniedException":{ "shape":"AccessDeniedException", "documentation":"The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
" }, "badGatewayException":{ "shape":"BadGatewayException", "documentation":"The request failed due to a bad gateway error.
" }, "citation":{ "shape":"CitationEvent", "documentation":"A citation event.
" }, "conflictException":{ "shape":"ConflictException", "documentation":"Error occurred because of a conflict while performing an operation.
" }, "dependencyFailedException":{ "shape":"DependencyFailedException", "documentation":"The request failed due to a dependency error.
" }, "guardrail":{ "shape":"GuardrailEvent", "documentation":"A guardrail event.
" }, "internalServerException":{ "shape":"InternalServerException", "documentation":"An internal server error occurred. Retry your request.
" }, "output":{ "shape":"RetrieveAndGenerateOutputEvent", "documentation":"An output event.
" }, "resourceNotFoundException":{ "shape":"ResourceNotFoundException", "documentation":"The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.
" }, "serviceQuotaExceededException":{ "shape":"ServiceQuotaExceededException", "documentation":"Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.
" }, "throttlingException":{ "shape":"ThrottlingException", "documentation":"Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
" }, "validationException":{ "shape":"ValidationException", "documentation":"The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" } }, "documentation":"A retrieve and generate stream response output.
", "eventstream":true }, "RetrieveAndGenerateType":{ "type":"string", "enum":[ "KNOWLEDGE_BASE", "EXTERNAL_SOURCES" ] }, "RetrieveRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "retrievalQuery" ], "members":{ "guardrailConfiguration":{ "shape":"GuardrailConfiguration", "documentation":"Guardrail settings.
" }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier of the knowledge base to query.
", "location":"uri", "locationName":"knowledgeBaseId" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" }, "retrievalQuery":{ "shape":"KnowledgeBaseQuery", "documentation":"Contains the query to send the knowledge base.
" } } }, "RetrieveResponse":{ "type":"structure", "required":["retrievalResults"], "members":{ "guardrailAction":{ "shape":"GuadrailAction", "documentation":"Specifies if there is a guardrail intervention in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
A list of results from querying the knowledge base.
" } } }, "RetrievedReference":{ "type":"structure", "members":{ "content":{ "shape":"RetrievalResultContent", "documentation":"Contains the cited text from the data source.
" }, "location":{ "shape":"RetrievalResultLocation", "documentation":"Contains information about the location of the data source.
" }, "metadata":{ "shape":"RetrievalResultMetadata", "documentation":"Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" } }, "documentation":"Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
The identifier of the action group invocation.
" }, "invocationInputs":{ "shape":"InvocationInputs", "documentation":"A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" } }, "documentation":"Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
", "event":true, "sensitive":true }, "ReturnControlResults":{ "type":"structure", "members":{ "invocationId":{ "shape":"String", "documentation":"The action's invocation ID.
" }, "returnControlInvocationResults":{ "shape":"ReturnControlInvocationResults", "documentation":"The action invocation result.
" } }, "documentation":"An action invocation result.
" }, "RoutingClassifierModelInvocationOutput":{ "type":"structure", "members":{ "metadata":{ "shape":"Metadata", "documentation":"The invocation's metadata.
" }, "rawResponse":{ "shape":"RawResponse", "documentation":"The invocation's raw response.
" }, "traceId":{ "shape":"TraceId", "documentation":"The invocation's trace ID.
" } }, "documentation":"Invocation output from a routing classifier model.
", "sensitive":true }, "RoutingClassifierTrace":{ "type":"structure", "members":{ "invocationInput":{ "shape":"InvocationInput", "documentation":"The classifier's invocation input.
" }, "modelInvocationInput":{ "shape":"ModelInvocationInput", "documentation":"The classifier's model invocation input.
" }, "modelInvocationOutput":{ "shape":"RoutingClassifierModelInvocationOutput", "documentation":"The classifier's model invocation output.
" }, "observation":{ "shape":"Observation", "documentation":"The classifier's observation.
" } }, "documentation":"A trace for a routing classifier.
", "sensitive":true, "union":true }, "S3BucketName":{ "type":"string", "max":63, "min":3, "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" }, "S3Identifier":{ "type":"structure", "members":{ "s3BucketName":{ "shape":"S3BucketName", "documentation":"The name of the S3 bucket.
" }, "s3ObjectKey":{ "shape":"S3ObjectKey", "documentation":"The S3 object key for the S3 resource.
" } }, "documentation":"The identifier information for an Amazon S3 bucket.
" }, "S3Location":{ "type":"structure", "required":["uri"], "members":{ "uri":{ "shape":"S3Uri", "documentation":"The path to the Amazon S3 bucket where the image is stored.
" } }, "documentation":"Information about the Amazon S3 bucket where the image is stored.
" }, "S3ObjectDoc":{ "type":"structure", "required":["uri"], "members":{ "uri":{ "shape":"S3Uri", "documentation":"The file location of the S3 wrapper object.
" } }, "documentation":"The unique wrapper object of the document from the S3 location.
" }, "S3ObjectFile":{ "type":"structure", "required":["uri"], "members":{ "uri":{ "shape":"S3Uri", "documentation":"The uri of the s3 object.
" } }, "documentation":"Contains details of the s3 object where the source file is located.
" }, "S3ObjectKey":{ "type":"string", "max":1024, "min":1, "pattern":"^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" }, "S3Uri":{ "type":"string", "max":1024, "min":1, "pattern":"^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" }, "SatisfiedCondition":{ "type":"structure", "required":["conditionName"], "members":{ "conditionName":{ "shape":"String", "documentation":"The name of the condition that was satisfied.
" } }, "documentation":"Represents a condition that was satisfied during a condition node evaluation in a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The number of requests exceeds the service quota. Resubmit your request later.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "SessionArn":{ "type":"string", "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "SessionAttributesMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "SessionId":{ "type":"string", "max":100, "min":2, "pattern":"^[0-9a-zA-Z._:-]+$" }, "SessionIdentifier":{ "type":"string", "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})$" }, "SessionMetadataKey":{ "type":"string", "max":100, "min":1 }, "SessionMetadataMap":{ "type":"map", "key":{"shape":"SessionMetadataKey"}, "value":{"shape":"SessionMetadataValue"}, "max":50, "min":0 }, "SessionMetadataValue":{ "type":"string", "max":5000, "min":0 }, "SessionState":{ "type":"structure", "members":{ "conversationHistory":{ "shape":"ConversationHistory", "documentation":"The state's conversation history.
" }, "files":{ "shape":"InputFiles", "documentation":"Contains information about the files used by code interpreter.
" }, "invocationId":{ "shape":"String", "documentation":"The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
An array of configurations, each of which applies to a knowledge base attached to the agent.
" }, "promptSessionAttributes":{ "shape":"PromptSessionAttributesMap", "documentation":"Contains attributes that persist across a prompt and the values of those attributes.
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.
" }, "SessionStatus":{ "type":"string", "enum":[ "ACTIVE", "EXPIRED", "ENDED" ] }, "SessionSummaries":{ "type":"list", "member":{"shape":"SessionSummary"} }, "SessionSummary":{ "type":"structure", "required":[ "createdAt", "lastUpdatedAt", "sessionArn", "sessionId", "sessionStatus" ], "members":{ "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was created.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was last modified.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier for the session.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The current status of the session.
" } }, "documentation":"Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" }, "SessionTTL":{ "type":"integer", "box":true, "max":3600, "min":60 }, "Source":{ "type":"string", "enum":[ "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER" ], "sensitive":true }, "Span":{ "type":"structure", "members":{ "end":{ "shape":"SpanEndInteger", "documentation":"Where the text with a citation ends in the generated output.
" }, "start":{ "shape":"SpanStartInteger", "documentation":"Where the text with a citation starts in the generated output.
" } }, "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
The unique identifier of the flow alias to use for the flow execution.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowExecutionName":{ "shape":"FlowExecutionName", "documentation":"The unique name for the flow execution. If you don't provide one, a system-generated name is used.
" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow to execute.
", "location":"uri", "locationName":"flowIdentifier" }, "inputs":{ "shape":"FlowInputs", "documentation":"The input data required for the flow execution. This must match the input schema defined in the flow.
" }, "modelPerformanceConfiguration":{ "shape":"ModelPerformanceConfiguration", "documentation":"The performance settings for the foundation model used in the flow execution.
" } } }, "StartFlowExecutionResponse":{ "type":"structure", "members":{ "executionArn":{ "shape":"FlowExecutionIdentifier", "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" } } }, "StopFlowExecutionRequest":{ "type":"structure", "required":[ "executionIdentifier", "flowAliasIdentifier", "flowIdentifier" ], "members":{ "executionIdentifier":{ "shape":"FlowExecutionIdentifier", "documentation":"The unique identifier of the flow execution to stop.
", "location":"uri", "locationName":"executionIdentifier" }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"The unique identifier of the flow alias used for the execution.
", "location":"uri", "locationName":"flowAliasIdentifier" }, "flowIdentifier":{ "shape":"FlowIdentifier", "documentation":"The unique identifier of the flow.
", "location":"uri", "locationName":"flowIdentifier" } } }, "StopFlowExecutionResponse":{ "type":"structure", "required":["status"], "members":{ "executionArn":{ "shape":"FlowExecutionIdentifier", "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
" }, "status":{ "shape":"FlowExecutionStatus", "documentation":"The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
" } } }, "StopSequences":{ "type":"list", "member":{"shape":"String"}, "max":4, "min":0 }, "StreamingConfigurations":{ "type":"structure", "members":{ "applyGuardrailInterval":{ "shape":"StreamingConfigurationsApplyGuardrailIntervalInteger", "documentation":" The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Specifies whether to enable streaming for the final response. This is set to false by default.
Configurations for streaming.
" }, "StreamingConfigurationsApplyGuardrailIntervalInteger":{ "type":"integer", "box":true, "min":1 }, "String":{"type":"string"}, "SummaryText":{ "type":"string", "max":25000000, "min":0 }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagKey":{ "type":"string", "documentation":"Key of a tag
", "max":128, "min":1, "pattern":"^[a-zA-Z0-9\\s._:/=+@-]*$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"List of Tag Keys
", "max":200, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"TaggableResourcesArn", "documentation":"The Amazon Resource Name (ARN) of the resource to tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagsMap", "documentation":"An object containing key-value pairs that define the tags to attach to the resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "documentation":"Value of a tag
", "max":256, "min":0, "pattern":"^[a-zA-Z0-9\\s._:/=+@-]*$" }, "TaggableResourcesArn":{ "type":"string", "documentation":"ARN of Taggable resources: [session]
", "max":1011, "min":20, "pattern":"(^arn:aws(-[^:]+)?:bedrock:[a-zA-Z0-9-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$)" }, "TagsMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"A map of tag keys and values
", "max":200, "min":1 }, "Temperature":{ "type":"float", "box":true, "max":1, "min":0 }, "TextInferenceConfig":{ "type":"structure", "members":{ "maxTokens":{ "shape":"MaxTokens", "documentation":"The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" }, "stopSequences":{ "shape":"RAGStopSequences", "documentation":"A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" }, "temperature":{ "shape":"Temperature", "documentation":"Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" }, "topP":{ "shape":"TopP", "documentation":"A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
" } }, "documentation":"Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
The text in the text prompt to optimize.
" } }, "documentation":"Contains information about the text prompt to optimize.
", "sensitive":true }, "TextPromptTemplate":{ "type":"string", "max":4000, "min":1, "sensitive":true }, "TextPromptTextString":{ "type":"string", "max":200000, "min":1 }, "TextResponsePart":{ "type":"structure", "members":{ "span":{ "shape":"Span", "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" }, "text":{ "shape":"String", "documentation":"The part of the generated text that contains a citation.
" } }, "documentation":"Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
Specifies configurations for a knowledge base to use in transformation.
" }, "type":{ "shape":"TextToSqlConfigurationType", "documentation":"The type of resource to use in transformation.
" } }, "documentation":"Contains configurations for transforming text to SQL.
" }, "TextToSqlConfigurationType":{ "type":"string", "enum":["KNOWLEDGE_BASE"] }, "TextToSqlKnowledgeBaseConfiguration":{ "type":"structure", "required":["knowledgeBaseArn"], "members":{ "knowledgeBaseArn":{ "shape":"KnowledgeBaseArn", "documentation":"The ARN of the knowledge base
" } }, "documentation":"Contains configurations for a knowledge base to use in transformation.
" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"The number of requests exceeds the limit. Resubmit your request later.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "TopK":{ "type":"integer", "box":true, "max":500, "min":0 }, "TopP":{ "type":"float", "box":true, "max":1, "min":0 }, "Trace":{ "type":"structure", "members":{ "customOrchestrationTrace":{ "shape":"CustomOrchestrationTrace", "documentation":"Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" }, "failureTrace":{ "shape":"FailureTrace", "documentation":"Contains information about the failure of the interaction.
" }, "guardrailTrace":{ "shape":"GuardrailTrace", "documentation":"The trace details for a trace defined in the Guardrail filter.
" }, "orchestrationTrace":{ "shape":"OrchestrationTrace", "documentation":"Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
" }, "postProcessingTrace":{ "shape":"PostProcessingTrace", "documentation":"Details about the post-processing step, in which the agent shapes the response..
" }, "preProcessingTrace":{ "shape":"PreProcessingTrace", "documentation":"Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" }, "routingClassifierTrace":{ "shape":"RoutingClassifierTrace", "documentation":"A routing classifier's trace.
" } }, "documentation":"Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "sensitive":true, "union":true }, "TraceElements":{ "type":"structure", "members":{ "agentTraces":{ "shape":"AgentTraces", "documentation":"Agent trace information for the flow execution.
" } }, "documentation":"Contains trace elements for flow execution tracking.
", "sensitive":true, "union":true }, "TraceId":{ "type":"string", "max":16, "min":2 }, "TraceKnowledgeBaseId":{ "type":"string", "sensitive":true }, "TracePart":{ "type":"structure", "members":{ "agentAliasId":{ "shape":"AgentAliasId", "documentation":"The unique identifier of the alias of the agent.
" }, "agentId":{ "shape":"AgentId", "documentation":"The unique identifier of the agent.
" }, "agentVersion":{ "shape":"AgentVersion", "documentation":"The version of the agent.
" }, "callerChain":{ "shape":"CallerChain", "documentation":"The part's caller chain.
" }, "collaboratorName":{ "shape":"Name", "documentation":"The part's collaborator name.
" }, "eventTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time of the trace.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
" }, "trace":{ "shape":"Trace", "documentation":"Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" } }, "documentation":"Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "event":true, "sensitive":true }, "TransformationConfiguration":{ "type":"structure", "required":["mode"], "members":{ "mode":{ "shape":"QueryTransformationMode", "documentation":"The mode of the transformation.
" }, "textToSqlConfiguration":{ "shape":"TextToSqlConfiguration", "documentation":"Specifies configurations for transforming text to SQL.
" } }, "documentation":"Contains configurations for transforming the natural language query into SQL.
" }, "Type":{ "type":"string", "enum":[ "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT" ] }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"TaggableResourcesArn", "documentation":"The Amazon Resource Name (ARN) of the resource from which to remove tags.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"A list of keys of the tags to remove from the resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateSessionRequest":{ "type":"structure", "required":["sessionIdentifier"], "members":{ "sessionIdentifier":{ "shape":"SessionIdentifier", "documentation":"The unique identifier of the session to modify. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
" } } }, "UpdateSessionResponse":{ "type":"structure", "required":[ "createdAt", "lastUpdatedAt", "sessionArn", "sessionId", "sessionStatus" ], "members":{ "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was created.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp for when the session was last modified.
" }, "sessionArn":{ "shape":"SessionArn", "documentation":"The Amazon Resource Name (ARN) of the session that was updated.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The unique identifier of the session you updated.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"The status of the session you updated.
" } } }, "Usage":{ "type":"structure", "members":{ "inputTokens":{ "shape":"Integer", "documentation":"Contains information about the input tokens from the foundation model usage.
" }, "outputTokens":{ "shape":"Integer", "documentation":"Contains information about the output tokens from the foundation model usage.
" } }, "documentation":"Contains information of the usage of the foundation model.
", "sensitive":true }, "Uuid":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"Input validation failed. Check your request parameters and retry the request.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "VectorSearchBedrockRerankingConfiguration":{ "type":"structure", "required":["modelConfiguration"], "members":{ "metadataConfiguration":{ "shape":"MetadataConfigurationForReranking", "documentation":"Contains configurations for the metadata to use in reranking.
" }, "modelConfiguration":{ "shape":"VectorSearchBedrockRerankingModelConfiguration", "documentation":"Contains configurations for the reranker model.
" }, "numberOfRerankedResults":{ "shape":"VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger", "documentation":"The number of results to return after reranking.
" } }, "documentation":"Contains configurations for reranking with an Amazon Bedrock reranker model.
" }, "VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "VectorSearchBedrockRerankingModelConfiguration":{ "type":"structure", "required":["modelArn"], "members":{ "additionalModelRequestFields":{ "shape":"AdditionalModelRequestFields", "documentation":"A JSON object whose keys are request fields for the model and whose values are values for those fields.
" }, "modelArn":{ "shape":"BedrockRerankingModelArn", "documentation":"The ARN of the reranker model to use.
" } }, "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" }, "VectorSearchRerankingConfiguration":{ "type":"structure", "required":["type"], "members":{ "bedrockRerankingConfiguration":{ "shape":"VectorSearchBedrockRerankingConfiguration", "documentation":"Contains configurations for an Amazon Bedrock reranker model.
" }, "type":{ "shape":"VectorSearchRerankingConfigurationType", "documentation":"The type of reranker model.
" } }, "documentation":"Contains configurations for reranking the retrieved results.
" }, "VectorSearchRerankingConfigurationType":{ "type":"string", "enum":["BEDROCK_RERANKING_MODEL"] }, "Verb":{ "type":"string", "sensitive":true }, "Version":{ "type":"string", "max":5, "min":1, "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" }, "VideoSegment":{ "type":"structure", "required":["s3Uri"], "members":{ "s3Uri":{ "shape":"VideoSegmentS3UriString", "documentation":"The S3 URI where this specific video segment is stored in the multimodal storage destination.
" }, "summary":{ "shape":"String", "documentation":"A text summary describing the content of the video segment.
" } }, "documentation":"Contains information about a video segment retrieved from a knowledge base, including its location and summary.
This data type is used in the following API operations:
Retrieve response – in the video field
Contains APIs related to model invocation and querying of knowledge bases.
" }